Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DominicDirkx authored Jan 14, 2025
1 parent 05cb041 commit f7b2e7c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@ Welcome to the repository showcasing example applications set up with Tudatpy!
If you want to know more about Tudatpy, please visit the [Tudat website](https://docs.tudat.space/en/latest/).
The website also holds the [examples from this repo rendered as notebooks](https://docs.tudat.space/en/latest/_src_getting_started/examples.html).

## Format
## Running

The examples are available as both Jupyter Notebooks and raw ``.py`` scripts. The Python scripts are auto-generated from the Jupyter notebooks to ensure consistency, using the ``create_scripts.py`` script in this repo.

### Jupyter Notebook

To run these examples, first create the `tudat-space` conda environment to install `tudatpy` and its required dependencies, as described [here](https://docs.tudat.space/en/latest/_src_getting_started/installation.html).

Then, make sure that the `tudat-space` environment is activated:
Expand All @@ -25,6 +23,8 @@ If you wish to be able to run the `Pygmo` examples, this package also need to be
conda install pygmo
```

### Jupyter Notebook

The `tudat-space` environment has to be added to the Jupyter kernel, running the following:

```bash
Expand Down

0 comments on commit f7b2e7c

Please sign in to comment.