Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DominicDirkx committed Nov 11, 2023
1 parent b193774 commit bd34173
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions README.md
Expand Up @@ -2,24 +2,15 @@

Welcome to the repository showcasing example applications set up with Tudatpy!

If you want to know more about Tudatpy, please visit the [Tudat Space](https://tudat-space.readthedocs.io/en/latest/).
If you want to know more about Tudatpy, please visit the [Tudat website]([https://tudat-space.readthedocs.io/en/latest/](https://docs.tudat.space/en/latest/)).

## Format

The examples are available as both Jupyter Notebooks and raw ``.py`` scripts.

### MyBinder

We set up a repository on [MyBinder](https://mybinder.org/v2/gh/tudat-team/tudatpy-examples/master): this way, you can explore and run the examples online, without having to set up a development environment or installing the tudatpy conda environment. Click on the button below to
launch the examples on ``mybinder``:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tudat-team/tudatpy-examples/master)

### Jupyter Notebook
You can alternatively run the Jupyter notebooks directly on your computer.
To do so, first create the `tudat-space` conda environment to install `tudatpy` and its required depedencies.

A detailed guide on how to do this can be found in the [tudatpy user guide](https://tudat-space.readthedocs.io/en/latest/_src_getting_started/installation.html).
To run these examples, first create the `tudat-space` conda environment to install `tudatpy` and its required depedencies, 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 Down Expand Up @@ -49,14 +40,11 @@ jupyter notebook

### Static code

Otherwise, you can clone this repository, open the examples on your favorite IDE, and install the `tudat-space` conda environment.

More instructions are reported in the guides hosted on [Tudat Space](https://tudat-space.readthedocs.io/en/latest/).
To run the examples as regular Python files, you can clone this repository, open the examples on your favorite IDE, and install the `tudat-space` conda environment, as described [here](https://docs.tudat.space/en/latest/_src_getting_started/installation.html).

All of the examples, provided as `.py` files, can then be run and edited as you see fit.

Please note that these `.py` files were generated from the Jupyter Notebooks.
The clarity and format of the code may suffer from this, and we advise to run the notebooks for a simpler user experience.

## Content

Expand Down Expand Up @@ -92,6 +80,12 @@ Examples showing how to optimize a problem modelled with Tudatpy via algorithms
- ``asteroid_orbit_optimization``: simulates the orbit around the Itokawa asteroid and finds the initial state that
ensures optimal coverage and close approaches

### MyBinder

We set up a repository on [MyBinder](https://mybinder.org/v2/gh/tudat-team/tudatpy-examples/master): this way, you can explore and run the examples online, without having to set up a development environment or installing the tudatpy conda environment. Click on the button below to
launch the examples on ``mybinder``:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tudat-team/tudatpy-examples/master)

## Contribute

Expand All @@ -101,4 +95,4 @@ Here are some points to be kept in mind.
1. Any modification or addition to this set of examples should be made in a personal fork of the current repository. No changes are to be done directly on a local clone of this repo.
2. The example should be written directly on a Jupyter notebook (.ipynb file). Then, the following command can be run from the CLI to create a .py file with the same code as the notebook file: `jupyter nbconvert --to python mynotebook.ipynb`. Make sure to change `mynotebook` to the name of the notebook file.
3. The markdown blocks are not optimally converted. Thus, once the .py file is created as described above, the script `clean_py_notebooks.py` is to be executed. This file reformats the markdown blocks in the .py files into a more readable look. Sometimes this cleanup is not perfect, so manually check the .py file to make sure everything is fine and correct anything that is not.
4. At this point, the example is complete. You are ready to create a pull request from your personal fork to the current repository, and the admins will take it from there.
4. At this point, the example is complete. You are ready to create a pull request from your personal fork to the current repository, and the admins will take it from there.

0 comments on commit bd34173

Please sign in to comment.