Developer guide progress.
Hi, For quite some time we have been discussing producing an updated developers guide to mimic the user-guide in Nektar++ but describing some of the conceptual points about the code layout and also aiming to help answer potential developers questions as to the layout an philosophy of Nektar++. We are progressing with this and currently have an incomplete draft document which currently just highlights how we are planning to layout the new guide. We are happy to share the current incomplete draft of the document and its periodic updates for your reference and possibly any comments (we will write to you when it is in a more complete state for more detailed comments). I also attach below a copy of the old developer’s guide we constructed a rather long time ago. If you wish to have to directly compile the document so that you can see updates as they occur (or even add some information in a branch) there is a version in the repository nektar/developer-guide. Since we are trying to use some of the code information in the document to compile the repository we recommend you do the following: Assuming you have already built the latest Nektar++ 'master' branch, 1) cd to $NEKTAR 2) git submodule update --init docs/developer-guide 3) cd build 4) cmake .. 5) make developer-guide-pdf The developer guide should now be at $NEKTAR/build/docs/developer-guide/developers-guide.pdf Cheers, Spencer. Spencer Sherwin FREng, FRAeS Head, Aerodynamics, Professor of Computational Fluid Mechanics, Department of Aeronautics, Imperial College London South Kensington Campus, London, SW7 2AZ, UK s.sherwin@imperial.ac.uk<mailto:s.sherwin@imperial.ac.uk> +44 (0)20 7594 5052 http://www.imperial.ac.uk/people/s.sherwin/
participants (1)
-
Sherwin, Spencer J