| Name | rocketserializer JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Easily convert your OpenRocket files into RocketPy simulations. |
| upload_time | 2024-06-15 23:21:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 20XX RocketPy Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
python
simulation
aerospace
motor
flight-simulator
trajectory
trajectory-simulator
rocket-simulator
openrocket
rocket-simulation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./static/LogoWhiteonTransparentBG-ByRocketeersForRocketeers.png">
<source media="(prefers-color-scheme: light)" srcset="./static/LogoBlackonTransparentBG-ByRocketeersForRocketeers.png">
<img alt="RocketPy Logo" src="https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/RocketPy_Logo_black.png">
</picture>
<br>
[](https://docs.rocketpy.org/en/latest/?badge=latest)
[](https://discord.gg/b6xYnNh)
[](https://github.com/sponsors/RocketPy-Team)
[](https://www.instagram.com/rocketpyteam)
[](https://www.linkedin.com/company/rocketpy)
<br>
# Rocket Serializer
`rocketserializer` is a Python library that provides serialization capabilities
for OpenRocket files. It allows you to read OpenRocket files (.ork) using a
simple and intuitive command line interface. After serializing the file, you
can use the data to create your RocketPy simulation.
## Example
<img src="./static/demo_2.gif" width="100%" />
## Installation
You can install `rocketserializer` using pip:
```shell
pip install rocketserializer
```
## Requirements
### Java
You need Java to be installed on your system to use `rocketserializer`.
We recommend downloading Java 17, which is required to run OpenRocket-23.09.
https://www.oracle.com/java/technologies/downloads/
### OpenRocket
You also need to download the OpenRocket JAR file. You can download it from the
following link:
https://openrocket.info/downloads.html?vers=23.09#content-JAR
Each version of OpenRocket has its own jar file, and it is important to use the
correct java version to run the jar file.
### Python Packages
Once you download the `rocketserializer` package, the following dependencies
will be automatically installed:
- bs4
- click>=8.0.0
- lxml
- numpy
- orhelper==0.1.3
- pyyaml
- rocketpy>=1.1.0
- nbformat>=5.2.0
## Usage - command line interface
The `rocketserializer` package will automatically install 2 command-line-interface (cli)
options, here's an example:
### Serialization
To create a `parameters.json` file from an OpenRocket file, use the following command:
```bash
ork2json --filepath your_rocket.ork
```
Or, for a more verbose output, you can use the following command:
```bash
ork2json --filepath your_rocket.ork --verbose True
```
The options are the following:
- `--filepath`: The .ork file to be serialized.
- `--output` : Path to the output folder. If not set, the output will be saved in the same folder as the `filepath`.
- `--ork_jar` : Specify the path to the OpenRocket jar file. If not set, the library will try to find the jar file in the current directory.
- `--encoding` : The encoding of the .ork file. By default, it is set to `utf-8`.
- `--verbose` : If you want to see the progress of the serialization, set this option to True. By default, it is set to False.
Only the `--filepath` option is mandatory.
### Creating a simulation notebook
```bash
ork2notebook --filepath your_rocket.ork
```
The options are pretty much the same as the serialization command!
### Limitations
This code won't work for your rocket if it has any of the following features:
- Your .ork file must be saved in English
- Your .ork file must be saved with at least 1 simulation data
- Only one single stage is supported
- Only a single motor is supported
- Only a single nose cone is supported
## Roadmap
- 2024 June : First public release, start receiving feedback from the community.
Before the first public release, we will listen to the community's feedback before defining the roadmap for the next releases.
## Contact
If you find any bug or if you want to request new features, please open an issue
on GitHub.
In case you don't have a GitHub account, you can reach out to us on RocketPy's
Discord server.
## How to Contribute
The 3 main ways of contributing to this project are:
1. **Reporting bugs and suggesting new features.**
- Use GitHub, preferably, to report bugs and suggest new features.
- In case you don't have a GitHub account, you can reach out to us on RocketPy's Discord server
2. **Sharing .ork files that can be used to test the library.**
- If you have a .ork file that is not working with the library, please share it with us.
- If you have a .ork file that is working with the library, please share it with us.
- If you allow us to use and share your .ork file, we can add it to the test suite.
3. **Developing new features and fixing bugs thorough pull requests on GitHub.**
- If you want to develop new features, you are more than welcome to do so.
- Please reach out to the maintainers to discuss the new feature before starting the development.
Raw data
{
"_id": null,
"home_page": null,
"name": "rocketserializer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "RocketPy Team <rocketpyteam@gmail.com>",
"keywords": "python, simulation, aerospace, motor, flight-simulator, trajectory, trajectory-simulator, rocket-simulator, openrocket, rocket-simulation",
"author": null,
"author_email": "Guilherme Fernandes <guilherme_fernandes@usp.br>, Patrick Sampaio <patricksampaio@usp.br>, Julio Machado <julioromac@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/1d/c8/113d5a4d96e98d3961e223651dbf107d376518a4a9b163b2ff8b36dd6065/rocketserializer-0.2.0.tar.gz",
"platform": null,
"description": "<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"./static/LogoWhiteonTransparentBG-ByRocketeersForRocketeers.png\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"./static/LogoBlackonTransparentBG-ByRocketeersForRocketeers.png\">\n <img alt=\"RocketPy Logo\" src=\"https://raw.githubusercontent.com/RocketPy-Team/RocketPy/master/docs/static/RocketPy_Logo_black.png\">\n</picture>\n\n<br>\n\n[](https://docs.rocketpy.org/en/latest/?badge=latest)\n[](https://discord.gg/b6xYnNh)\n[](https://github.com/sponsors/RocketPy-Team)\n[](https://www.instagram.com/rocketpyteam)\n[](https://www.linkedin.com/company/rocketpy)\n\n<br>\n\n# Rocket Serializer\n\n`rocketserializer` is a Python library that provides serialization capabilities\nfor OpenRocket files. It allows you to read OpenRocket files (.ork) using a\nsimple and intuitive command line interface. After serializing the file, you\ncan use the data to create your RocketPy simulation.\n\n## Example\n\n<img src=\"./static/demo_2.gif\" width=\"100%\" />\n\n## Installation\n\nYou can install `rocketserializer` using pip:\n\n```shell\npip install rocketserializer\n```\n\n## Requirements\n\n### Java\n\nYou need Java to be installed on your system to use `rocketserializer`.\nWe recommend downloading Java 17, which is required to run OpenRocket-23.09.\n\nhttps://www.oracle.com/java/technologies/downloads/\n\n### OpenRocket\n\nYou also need to download the OpenRocket JAR file. You can download it from the\nfollowing link:\n\nhttps://openrocket.info/downloads.html?vers=23.09#content-JAR\n\nEach version of OpenRocket has its own jar file, and it is important to use the\ncorrect java version to run the jar file.\n\n### Python Packages\n\nOnce you download the `rocketserializer` package, the following dependencies\nwill be automatically installed:\n\n- bs4\n- click>=8.0.0\n- lxml\n- numpy\n- orhelper==0.1.3\n- pyyaml\n- rocketpy>=1.1.0\n- nbformat>=5.2.0\n\n## Usage - command line interface\n\nThe `rocketserializer` package will automatically install 2 command-line-interface (cli)\noptions, here's an example:\n\n### Serialization\n\nTo create a `parameters.json` file from an OpenRocket file, use the following command:\n\n```bash\nork2json --filepath your_rocket.ork\n```\n\nOr, for a more verbose output, you can use the following command:\n\n```bash\nork2json --filepath your_rocket.ork --verbose True\n```\n\nThe options are the following:\n\n- `--filepath`: The .ork file to be serialized.\n- `--output` : Path to the output folder. If not set, the output will be saved in the same folder as the `filepath`.\n- `--ork_jar` : Specify the path to the OpenRocket jar file. If not set, the library will try to find the jar file in the current directory.\n- `--encoding` : The encoding of the .ork file. By default, it is set to `utf-8`.\n- `--verbose` : If you want to see the progress of the serialization, set this option to True. By default, it is set to False.\n\nOnly the `--filepath` option is mandatory.\n\n### Creating a simulation notebook\n\n```bash\nork2notebook --filepath your_rocket.ork\n```\n\nThe options are pretty much the same as the serialization command!\n\n### Limitations\n\nThis code won't work for your rocket if it has any of the following features:\n\n- Your .ork file must be saved in English\n- Your .ork file must be saved with at least 1 simulation data\n- Only one single stage is supported\n- Only a single motor is supported\n- Only a single nose cone is supported\n\n## Roadmap\n\n- 2024 June : First public release, start receiving feedback from the community.\n\nBefore the first public release, we will listen to the community's feedback before defining the roadmap for the next releases.\n\n## Contact\n\nIf you find any bug or if you want to request new features, please open an issue\non GitHub.\nIn case you don't have a GitHub account, you can reach out to us on RocketPy's\nDiscord server.\n\n## How to Contribute\n\nThe 3 main ways of contributing to this project are:\n\n1. **Reporting bugs and suggesting new features.**\n - Use GitHub, preferably, to report bugs and suggest new features.\n - In case you don't have a GitHub account, you can reach out to us on RocketPy's Discord server\n2. **Sharing .ork files that can be used to test the library.**\n - If you have a .ork file that is not working with the library, please share it with us.\n - If you have a .ork file that is working with the library, please share it with us.\n - If you allow us to use and share your .ork file, we can add it to the test suite.\n3. **Developing new features and fixing bugs thorough pull requests on GitHub.**\n - If you want to develop new features, you are more than welcome to do so.\n - Please reach out to the maintainers to discuss the new feature before starting the development. \n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 20XX RocketPy Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Easily convert your OpenRocket files into RocketPy simulations.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://docs.rocketpy.org/en/latest/",
"Issues": "https://github.com/RocketPy-Team/RocketSerializer/issues",
"Repository": "https://github.com/RocketPy-Team/RocketSerializer"
},
"split_keywords": [
"python",
" simulation",
" aerospace",
" motor",
" flight-simulator",
" trajectory",
" trajectory-simulator",
" rocket-simulator",
" openrocket",
" rocket-simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cbf474b59ae6a0444514efe6d87f402b883fb073e8591d5f0e3d476ae779a5a",
"md5": "63f1701731535ab131d5300a4764ed7a",
"sha256": "e8520f546f2b8c5bf7901882cfec48099798626f7ef6306577ae69d3a1aa08f2"
},
"downloads": -1,
"filename": "rocketserializer-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63f1701731535ab131d5300a4764ed7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 33842,
"upload_time": "2024-06-15T23:21:07",
"upload_time_iso_8601": "2024-06-15T23:21:07.238969Z",
"url": "https://files.pythonhosted.org/packages/5c/bf/474b59ae6a0444514efe6d87f402b883fb073e8591d5f0e3d476ae779a5a/rocketserializer-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1dc8113d5a4d96e98d3961e223651dbf107d376518a4a9b163b2ff8b36dd6065",
"md5": "1682a02a8a36a06d3632bb7ccbd1f2fe",
"sha256": "2783d2c171b588ef8fa9865811362d6e56f12c6764cb485640bac8c486ae2f46"
},
"downloads": -1,
"filename": "rocketserializer-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1682a02a8a36a06d3632bb7ccbd1f2fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 28470,
"upload_time": "2024-06-15T23:21:08",
"upload_time_iso_8601": "2024-06-15T23:21:08.882214Z",
"url": "https://files.pythonhosted.org/packages/1d/c8/113d5a4d96e98d3961e223651dbf107d376518a4a9b163b2ff8b36dd6065/rocketserializer-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-15 23:21:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RocketPy-Team",
"github_project": "RocketSerializer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rocketserializer"
}
