Installing nachos

Normal install

To install the latest version of nachos:

pip3 install --user --upgrade git+https://github.com/pierre-24/nachos.git

Note that --user allow you to install the package without being superuser (see here). You will probably need to add $HOME/.local/bin to $PATH for this to work:

echo 'PATH=$HOME/.local/bin:$PATH' >> ~/.bashrc

On the other hand, you can install it in a virtualenv (see below).

(optional) Patching Dalton

By default, it is possible to perform numerical differentiation with Dalton, but the following patch will improve different stuffs:

  • Increase values of some constants, so that more frequencies and responses functions can be computed in the same input ;

  • Outputs responses functions in a better place (DALTON.PROP in the archive), with more digits (important for the accuracy) ;

  • Allow to compute numerical differentiation of gamma (because it is otherwise not possible, since only the components that participate to \(\gamma_{||}\) are computed).

You can find the patch and instructions there.

Installation for contributors

To contribute to the project,

  • Fork it.

  • Clone your fork: git clone git@github.com:<USERNAME>/nachos.git.

  • Go in it: cd nachos

  • Install pip-tools: pip3 install pip-tools

  • Install virtualenv python3 -m venv venv; source venv/bin/activate

  • Install dependencies: make install-dev.

  • Add upstream: git remote add upstream https://github.com/pierre-24/nachos.git

  • Don’t forget to create a separate branch to implement your changes: git checkout -b my_branch upstream/dev.

See the contribution part.

You can launch the tests series with make test