| Name | tidye JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | Tidal simulation with multiple moons (for Emily) |
| upload_time | 2025-01-03 17:55:16 |
| maintainer | None |
| docs_url | None |
| author | William Dye |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# tidye - Tidal simulation with multiple moons in Python
[](https://pypi.org/project/tidye/) [](https://www.python.org/downloads/) [](https://pypi.org/project/tidye/) [](https://github.com/will2dye4/tidye/blob/master/LICENSE)
The `tidye` simulator calculates tidal interactions between a planet and one or more moons.
## Installation
The easiest way to install the package is to download it from [PyPI](https://pypi.org) using `pip`.
Note that `tidye` depends on [Python](https://www.python.org/downloads/) 3.9 or newer; please
ensure that you have a semi-recent version of Python installed before proceeding.
Run the following command in a shell (a UNIX-like environment is assumed):
```
$ pip install tidye
```
The package has a few external dependencies besides Python itself. If you wish to
sandbox your installation inside a virtual environment, you may choose to use
[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) or a similar
utility to do so.
When successfully installed, a program called `tidye` will be placed on your `PATH`.
See the Usage section below for details about how to use this program.
## Usage
The `tidye` program is a command-line interface for simulating tidal forces.
At any time, you can use the `-h` or `--help` flags to see a summary of options that
the program accepts.
```
$ tidye -h
usage: tidye [-h] [-d DURATION] file
Simulate lunar tides from a provided configuration file.
positional arguments:
file Path to config file (e.g., config.json)
optional arguments:
-h, --help show this help message and exit
-d DURATION, --duration DURATION
Simulation duration (defaults to two full orbits)
```
Typical usage is `tidye <config_file>`, where `<config_file>` is the path to a file
describing the configuration of the planet and moons that you wish to simulate. For an
example config file, see the `sample_config.json` included in the repository, or check
the example below:
```json
{
"planet": {
"mass": 1000
},
"moons": [
{
"mass": 100,
"orbital_radius": 300,
"orbital_period": 1
},
{
"mass": 200,
"orbital_radius": 500,
"orbital_period": 2,
"orbital_phase": 0.5
},
{
"mass": 150,
"orbital_radius": 400,
"geostationary": true
}
]
}
```
The program will produce a graph showing the tidal forces on the planet resulting from
each individual moon, as well as the cumulative force from all moons combined
(labeled `All`). See the image below for an example graph generated by `tidye`.
Raw data
{
"_id": null,
"home_page": null,
"name": "tidye",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "William Dye",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/10/60/2f617ddac016a964819184e1979089afda334522a23002813498c1bd6365/tidye-0.1.4.tar.gz",
"platform": null,
"description": "# tidye - Tidal simulation with multiple moons in Python\n\n[](https://pypi.org/project/tidye/) [](https://www.python.org/downloads/) [](https://pypi.org/project/tidye/) [](https://github.com/will2dye4/tidye/blob/master/LICENSE)\n\nThe `tidye` simulator calculates tidal interactions between a planet and one or more moons.\n\n## Installation\n\nThe easiest way to install the package is to download it from [PyPI](https://pypi.org) using `pip`.\nNote that `tidye` depends on [Python](https://www.python.org/downloads/) 3.9 or newer; please\nensure that you have a semi-recent version of Python installed before proceeding.\n\nRun the following command in a shell (a UNIX-like environment is assumed):\n\n```\n$ pip install tidye\n```\n\nThe package has a few external dependencies besides Python itself. If you wish to\nsandbox your installation inside a virtual environment, you may choose to use\n[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) or a similar\nutility to do so.\n\nWhen successfully installed, a program called `tidye` will be placed on your `PATH`.\nSee the Usage section below for details about how to use this program.\n\n## Usage\n\nThe `tidye` program is a command-line interface for simulating tidal forces.\n\nAt any time, you can use the `-h` or `--help` flags to see a summary of options that\nthe program accepts.\n\n```\n$ tidye -h\nusage: tidye [-h] [-d DURATION] file\n\nSimulate lunar tides from a provided configuration file.\n\npositional arguments:\n file Path to config file (e.g., config.json)\n\noptional arguments:\n -h, --help show this help message and exit\n -d DURATION, --duration DURATION\n Simulation duration (defaults to two full orbits)\n```\n\nTypical usage is `tidye <config_file>`, where `<config_file>` is the path to a file\ndescribing the configuration of the planet and moons that you wish to simulate. For an\nexample config file, see the `sample_config.json` included in the repository, or check\nthe example below:\n\n```json\n{\n \"planet\": {\n \"mass\": 1000\n },\n \"moons\": [\n {\n \"mass\": 100,\n \"orbital_radius\": 300,\n \"orbital_period\": 1\n },\n {\n \"mass\": 200,\n \"orbital_radius\": 500,\n \"orbital_period\": 2,\n \"orbital_phase\": 0.5\n },\n {\n \"mass\": 150,\n \"orbital_radius\": 400,\n \"geostationary\": true\n }\n ]\n}\n```\n\nThe program will produce a graph showing the tidal forces on the planet resulting from\neach individual moon, as well as the cumulative force from all moons combined\n(labeled `All`). See the image below for an example graph generated by `tidye`.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Tidal simulation with multiple moons (for Emily)",
"version": "0.1.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46dbe5d1e0d4f40bbfb250e05fba16eb819c7d5e2e3b333d7ee644b22454dbc3",
"md5": "93aa4ffb1035627dfc2a39ffed63aef7",
"sha256": "b6ca9bb68d432776c81fe8728ac76f6f0d53830bcf7844356fe1fc6d93c0da03"
},
"downloads": -1,
"filename": "tidye-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93aa4ffb1035627dfc2a39ffed63aef7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 5824,
"upload_time": "2025-01-03T17:55:14",
"upload_time_iso_8601": "2025-01-03T17:55:14.883448Z",
"url": "https://files.pythonhosted.org/packages/46/db/e5d1e0d4f40bbfb250e05fba16eb819c7d5e2e3b333d7ee644b22454dbc3/tidye-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10602f617ddac016a964819184e1979089afda334522a23002813498c1bd6365",
"md5": "e541795987837369c16eb3984018e32f",
"sha256": "bcbe1e3e33ec14a64ff98963615efc85f8222c925becc6b3e332787fbf2108f2"
},
"downloads": -1,
"filename": "tidye-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "e541795987837369c16eb3984018e32f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 4578,
"upload_time": "2025-01-03T17:55:16",
"upload_time_iso_8601": "2025-01-03T17:55:16.816285Z",
"url": "https://files.pythonhosted.org/packages/10/60/2f617ddac016a964819184e1979089afda334522a23002813498c1bd6365/tidye-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-03 17:55:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tidye"
}
