diff --git a/README.md b/README.md index 859acf9cb419441cf9b446ddfe95048356ca5062..b0edec4b340dc4291d6761fe2ed92165cdbda621 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Installation + There are two methods to install the environment which is needed for following the NIFTy tutorial. First, install it regularly into the home folder of your machine. Second, use a Docker container. The advantage of the second approach is -that it is going to work without any problems most likely. Its downsides are: -Root access to start the Docker container (security implications), a full Docker -installation (security implications), you need to be familiar with Docker in -order to get your results out of the container. +that the chance that it runs on a variety of machines is relatively high. The +downsides are: You need root access to build and start the Docker container +(security implications), a full Docker installation (security implications) and +you need to be familiar with Docker in order to get your results out of the +container. ## Standard @@ -17,10 +19,10 @@ order to get your results out of the container. # apt-get install git python3-pip python3-scipy python3-matplotlib ``` -- Install our Fouier transform package `pypocketfft`: +- Optionally, install our Fourier transform package `ducc0`: ``` -$ pip3 install --user git+https://gitlab.mpcdf.mpg.de/mtr/pypocketfft.git +$ pip3 install ducc0 ``` - Clone this repository: @@ -33,15 +35,15 @@ $ git clone --recursive https://gitlab.mpcdf.mpg.de/ift/nifty_tutorial.git ``` $ cd nifty_tutorial/nifty -$ pip3 install --user . +$ pip3 install . ``` ## Docker -- Build the image: +- To build the image, run the following command inside the `nifty_tutorial` + folder. ``` -$ git clone https://gitlab.mpcdf.mpg.de/ift/nifty_tutorial.git # docker build -t niftytutorial . ``` @@ -56,4 +58,3 @@ $ git clone https://gitlab.mpcdf.mpg.de/ift/nifty_tutorial.git Run the scripts `*_solution.py` from the repository, check that they run through and look at the output plots. - diff --git a/nifty b/nifty index b07033aa8221b419cd0e5de671a199025afcb659..55974d18cc25277d882b2f2678011ccff6cbbeec 160000 --- a/nifty +++ b/nifty @@ -1 +1 @@ -Subproject commit b07033aa8221b419cd0e5de671a199025afcb659 +Subproject commit 55974d18cc25277d882b2f2678011ccff6cbbeec