Skip to content

Commit cc3f2ff

Browse files
committed
more sections on tidymess docs
1 parent e1cdab5 commit cc3f2ff

1 file changed

Lines changed: 24 additions & 2 deletions

File tree

doc/tutorial/adding_example_code_tidymess.rst

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ implements detailed tidal forces into an N-body code to track the deformation
1010
of bodies. This community code has already been implemented into AMUSE so you
1111
can follow along this tutorial.
1212

13+
.. NOTE::
14+
15+
In this guide, ``TIDYMESS`` refers to the standalone simulation package,
16+
while ``Tidymess`` refers to the ``TIDYMESS`` package inside of ``AMUSE``.
17+
18+
1319
Getting Started
1420
===============
1521

@@ -72,10 +78,26 @@ package is buildable given the available compilers and libraries detected on you
7278
to determine what compilers and libraries are on the system and how to use them. For this we will edit
7379
the ``configure.ac`` file in ``amuse_tidymess/support/``. This file contains a set of macros which will
7480
detect the tools and libraries needed to build our package. The template should contain all the macros
75-
needed for our package, so its just a matter of deleting what we don't need.
81+
needed for our package, so its just a matter of deleting what we don't need. Delete any comment prefaced
82+
with ``#####``, but only after following the direction of the comment.
83+
84+
Once ``configure.ac`` is setup correctly, we can edit ``config.mk.in``, and remove any unneeded variables
85+
as well as any ``#####`` comment. This file is a template for ``config.mk``, which will contain a description
86+
of all the compiler and library variables needed for our package.
87+
88+
Once these files are cleaned up, run ``autoreconf`` to (re)create the ``configure`` script, then run
89+
``./configure``. This will test the detection and check for errors. As a sanity check, run ``cat config.mk``
90+
and ensure that there are no ``@VARIABLE@`` symbols left! If there are, check that ``configure.ac`` and
91+
``config.mk.in`` were setup correctly.
7692

7793
.. WARNING::
7894

7995
Make sure the the ``amuse_tidymess/support/shared/`` folder is a simlink to ``amuse/support/shared/``
8096
to ensure that there is no code duplication in the codebase, and that bug fixes are propagated to each
81-
package automatically.
97+
package automatically. This should be done automatically by the ``amusifier`` but can be a source of bugs
98+
if not setup correctly.
99+
100+
Setting up the Makefile
101+
~~~~~~~~~~~~~~~~~~~~~~~
102+
With our build system detection working, we now need to download ``TIDYMESS`` into ``AMUSE``!
103+
This is where the Makefiles come in. ``AMUSE`` packages typically have 2 Makefiles.

0 commit comments

Comments
 (0)