https://github.com/spaceteam/ortools
Tools and scripts for OpenRocket
https://github.com/spaceteam/ortools
Last synced: about 1 year ago
JSON representation
Tools and scripts for OpenRocket
- Host: GitHub
- URL: https://github.com/spaceteam/ortools
- Owner: SpaceTeam
- License: mit
- Created: 2021-05-13T18:11:27.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-23T16:58:38.000Z (almost 3 years ago)
- Last Synced: 2025-03-24T19:21:40.488Z (about 1 year ago)
- Language: Python
- Size: 1.39 MB
- Stars: 16
- Watchers: 7
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ortools
Tools and scripts for [OpenRocket](https://openrocket.info/) using Python and
[orhelper](https://pypi.org/project/orhelper/).
As an example result, see the image from a landing scatter visualization produced by the 6DOF dispersion analysis tool `diana`
## Installation
### Using docker
Install docker. Build a docker container using the provided dockerfile
```bash
docker build . -t ortools -f Dockerfile
```
Run a shipped example with
Install docker. Build a docker container using the provided dockerfile
```bash
docker run -it ortools
```
and examine the console output.
To run a command with your data from the current folder, mount PWD into the docker container, and pass it as working and output directory to diana
```bash
docker run -v $PWD:/ortools/data -it ortools diana -d data -o data/dockertest
```
### Locally
You should use Java 8 (a really, really old version) for this to work, see [orhelper](https://pypi.org/project/orhelper/). However, it may run with a newer java version even if the GUI of OpenRocket does not start.
Additionally, install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) for compiling `jpype1`.
Tested with the following version combinations:
* miniconda3-py39 with python3.9, openjdk 1.8.0_312-1, orhelper 0.1.2, Windows 10
* miniconda3-py39 with python3.9, oracle jdk1.8.0_202, orhelper 0.1.2, Windows 10
* Python 3.8.5, openjdk 11.0.11, Ubuntu 20.04
An installation on Mac OS was not successful so far. If you have figured that out, please let us know!
1. Download or clone the project.
2. Create and activate some conda or pip environment with Python 3. E.g.:
```shell
conda create -n ortools python=3
conda activate ortools
```
3. Install the package with pip. If you are a developer, install the package in editable mode. If not, leave out the `-e`
flag for a normal installation. In editable mode, all changes to the source files are immediately
reflected in your environment, so you don't have to reinstall/update the package after changes.
```shell
cd ortools
pip install -e .
```
All required packages will be automatically installed with pip too. If you don't like that, you
can check [setup.cfg](setup.cfg) for the dependencies and install them beforehand with conda
(except for orhelper which is only available via pip).
```shell
conda install numpy matplotlib click configparser simplekml scipy pyproj
pip install orhelper
```
If jpype install fails, check if Microsoft C++ Build Tools are installed, and `JAVA_HOME` is set properly.
If used with python 3.10, build jpype manually with [this source](https://github.com/jpype-project/jpype/commit/bbdca907d053f1e04e4dcd414d4ebce8f9da6313),
see the [following github-PR](https://github.com/kylebarron/pydelatin/pull/24).
4. `diana` needs to find `OpenRocket-15.03.jar`. Put it in the same folder where you run `diana`, or add the file (not the folder)
to an environment variable called `CLASSPATH`,
see [the oracle documentation](https://docs.oracle.com/javase/tutorial/essential/environment/paths.html).
Check with (example for Windows)
```shell
echo %CLASSPATH%
```
>$ PATHTTO\projects\OpenRocket-15.03.jar
```shell
java -jar "%CLASSPATH%"
```
and OR should be launched.
## Usage
So far only one command line tool is in development. It is called `diana` and does dispersion
analyses. Just execute
```shell
diana
```
in the examples-directory of `ortools` to run with the provided examples.
Run
```shell
diana -h
```
to get help and usage information. For further information, check the [Wiki](https://github.com/SpaceTeam/ortools/wiki).
## Contribution
- If you have general questions, feel free to use the [Discussions Feature](https://github.com/SpaceTeam/ortools/discussions)
- For any other contributions, see the [CONTRIBUTING instructions](CONTRIBUTING.md)
## Credits
- [SilentSys](https://github.com/SilentSys) for [orhelper](https://github.com/SilentSys/orhelper)
- The community behind [OpenRocket](https://github.com/openrocket/openrocket)
- RocketSam2016 with his idea of the [multilevel wind model](https://www.rocketryforum.com/threads/new-openrocket-plugin-to-allow-different-wind-speed-direction-at-different-altitudes.140619/)