Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefsmeets committed Aug 8, 2024
1 parent 2fcdb92 commit bb9b0c7
Showing 1 changed file with 34 additions and 8 deletions.
42 changes: 34 additions & 8 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,34 @@
This page shows you how to get started using JANUS.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
# Getting started

JANUS contains a small CLI tool to help get set up with JANUS.

## Install SOCRATES

Download and install SOCRATES:

```console
janus download socrates
```

Make sure you have the netcdf fortran libraries installed:

```
sudo apt install libnetcdff-dev netcdf-bin
```

## Download data

Download spectral and stellar data:

```console
janus download spectral
janus download stellar
```

## Environment variables

If you install and compile [SOCRATES](https://github.com/nichollsh/SOCRATES) yourself, you can specify the path using the `SOCRATES` environment variable, e.g.

```console
SOCRATES=/home/user/path/to/SOCRATES pytest
```

0 comments on commit bb9b0c7

Please sign in to comment.