Skip to content

Commit

Permalink
Merge branch 'develop-basic' into master-basic
Browse files Browse the repository at this point in the history
  • Loading branch information
mlietzow committed Jan 17, 2024
2 parents 7115070 + 9aa3073 commit bd3ae10
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,21 @@ To install POLARIS, run the installation script:
./compile.sh -f
```
For the first installation, the option `-f` is required to install the [CCfits](https://heasarc.gsfc.nasa.gov/fitsio/CCfits/) and [cfitsio](https://heasarc.gsfc.nasa.gov/fitsio/) libraries.
Alternatively, these libraries can be installed with a package manager (root permissions are required):
```bash
sudo apt update
sudo apt install libccfits-dev libcfitsio-dev
```
If these packages are installed on the system, simply install POLARIS via
```bash
./compile.sh
```
For more information, type:
```bash
./compile.sh -h
```
POLARIS can now be executed from any newly opened terminal/console.
However, to use it in already open terminals/consoles, execute the following command to update the environmental paths:
To use it in already open terminals/consoles, execute the following command to update the environmental paths:
```bash
source ~/.bashrc
```
Expand Down Expand Up @@ -78,7 +87,7 @@ If line radiative transfer and/or Zeeman simulations are used, please cite [Brau
├── projects # Output directory to store simulation results and examples
│ ├── disk # Exemplary disk model
│ ├── test # Models for testing purposes
│ └── CommandList.cmd # List of avaiable POLARIS commands
│ └── CommandList.cmd # List of available POLARIS commands
├── src # Source files of the POLARIS code
├── tools # PolarisTools directory
│ ├── polaris_tools_custom # User-definable modules for PolarisTools
Expand Down
Binary file modified manual.pdf
Binary file not shown.

0 comments on commit bd3ae10

Please sign in to comment.