choreo


Namechoreo JSON
Version 1.0.0rc0 PyPI version JSON
download
home_pageNone
SummaryA set of tools to compute periodic solutions to the Newtonian N-body problem
upload_time2025-07-10 15:36:44
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords ode periodic n-body gravitation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # choreo
Finds periodic solutions to the gravitational N-body problem. 

## Try out this project, no installation required!

Check out the online in-browser GUI: https://gabrielfougeron.github.io/choreo/

## Build wheel for pyodide to be used in GUI

After sourcing emsdk environment, run the following:

```
pyodide build && python -m build --sdist
```

## Install the package with pip

The package is not available on PyPA yet, but will be in the future.
Till then, the installation process is the following:

 - Download this project. For instance using git: `git clone git@github.com:gabrielfougeron/choreo.git`
 - Open the directory: `cd choreo`
 - Build and install using pip: `pip install .`

## Power up the GUI solver with the CLI backend
Using clang or gcc as a C compiler, the single-threaded CLI solver is about 3 times faster that the wasm in-browser GUI solver. In addition, several independent single-threaded solvers can be launched simultaneously using a single command.

To use the CLI backend, follow these steps:

- Install the package
- In the GUI, define a workspace folder under `Play => Workspace => Setup Workspace`
- Every time the workspace is reloaded under `Play => Workspace => Reload Workspace` **or** every time a new initial state is generated in the GUI, a new configuration file `choreo_config.json` is written to disk.
- In the command line, run the installed script as `choreo_CLI_search -f /path/to/workspace/folder/` 

## Online documentation

Available at: https://gabrielfougeron.github.io/choreo-docs/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "choreo",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "ODE, periodic, N-body, gravitation",
    "author": null,
    "author_email": "Gabriel Fougeron <gabriel.fougeron@hotmail.fr>",
    "download_url": "https://files.pythonhosted.org/packages/7b/2d/591e700b8ba769c63279b6f85fffa39636bf856988a07c2108df5f545903/choreo-1.0.0rc0.tar.gz",
    "platform": null,
    "description": "# choreo\nFinds periodic solutions to the gravitational N-body problem. \n\n## Try out this project, no installation required!\n\nCheck out the online in-browser GUI: https://gabrielfougeron.github.io/choreo/\n\n## Build wheel for pyodide to be used in GUI\n\nAfter sourcing emsdk environment, run the following:\n\n```\npyodide build && python -m build --sdist\n```\n\n## Install the package with pip\n\nThe package is not available on PyPA yet, but will be in the future.\nTill then, the installation process is the following:\n\n - Download this project. For instance using git: `git clone git@github.com:gabrielfougeron/choreo.git`\n - Open the directory: `cd choreo`\n - Build and install using pip: `pip install .`\n\n## Power up the GUI solver with the CLI backend\nUsing clang or gcc as a C compiler, the single-threaded CLI solver is about 3 times faster that the wasm in-browser GUI solver. In addition, several independent single-threaded solvers can be launched simultaneously using a single command.\n\nTo use the CLI backend, follow these steps:\n\n- Install the package\n- In the GUI, define a workspace folder under `Play => Workspace => Setup Workspace`\n- Every time the workspace is reloaded under `Play => Workspace => Reload Workspace` **or** every time a new initial state is generated in the GUI, a new configuration file `choreo_config.json` is written to disk.\n- In the command line, run the installed script as `choreo_CLI_search -f /path/to/workspace/folder/` \n\n## Online documentation\n\nAvailable at: https://gabrielfougeron.github.io/choreo-docs/\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A set of tools to compute periodic solutions to the Newtonian N-body problem",
    "version": "1.0.0rc0",
    "project_urls": {
        "Changelog": "https://github.com/gabrielfougeron/choreo/releases/",
        "Documentation": "https://gabrielfougeron.github.io/choreo-docs/",
        "Homepage": "https://gabrielfougeron.github.io/choreo/",
        "Repository": "https://github.com/gabrielfougeron/choreo"
    },
    "split_keywords": [
        "ode",
        " periodic",
        " n-body",
        " gravitation"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1efc46afb0523c62f8d90a3ebc4e657376954c3828c6bc0d8b91437c2cfbf313",
                "md5": "933cccccfdd9b890ee65be6d6456fb2a",
                "sha256": "826325a1c00fd640d5cd3e195969a01e51d5cf62f3a208321d1ea6e5a2cb336c"
            },
            "downloads": -1,
            "filename": "choreo-1.0.0rc0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "has_sig": false,
            "md5_digest": "933cccccfdd9b890ee65be6d6456fb2a",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": ">=3.10",
            "size": 8978633,
            "upload_time": "2025-07-10T15:36:37",
            "upload_time_iso_8601": "2025-07-10T15:36:37.261017Z",
            "url": "https://files.pythonhosted.org/packages/1e/fc/46afb0523c62f8d90a3ebc4e657376954c3828c6bc0d8b91437c2cfbf313/choreo-1.0.0rc0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b7ef9f57c73427c5cd1fb2d6e562b8a142bcd200b669f7c2305a98183114ee63",
                "md5": "5d37be5043f62bd33f34732abe123495",
                "sha256": "584e3126d43a38de85529173b4417ea4c74d51e3194f20d8dd314b88bba8121f"
            },
            "downloads": -1,
            "filename": "choreo-1.0.0rc0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "has_sig": false,
            "md5_digest": "5d37be5043f62bd33f34732abe123495",
            "packagetype": "bdist_wheel",
            "python_version": "cp311",
            "requires_python": ">=3.10",
            "size": 9322970,
            "upload_time": "2025-07-10T15:36:39",
            "upload_time_iso_8601": "2025-07-10T15:36:39.903391Z",
            "url": "https://files.pythonhosted.org/packages/b7/ef/9f57c73427c5cd1fb2d6e562b8a142bcd200b669f7c2305a98183114ee63/choreo-1.0.0rc0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "02b1234b372afe8504f2a0f144c4f120beae171b1102cd866a44eaa900103852",
                "md5": "1e03d1a6737694ab0c22bd9c5216084f",
                "sha256": "8258b265d6f65f266b563aa414ea272986f5322f5b21811d9ce86386b0391b2c"
            },
            "downloads": -1,
            "filename": "choreo-1.0.0rc0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "has_sig": false,
            "md5_digest": "1e03d1a6737694ab0c22bd9c5216084f",
            "packagetype": "bdist_wheel",
            "python_version": "cp312",
            "requires_python": ">=3.10",
            "size": 9112480,
            "upload_time": "2025-07-10T15:36:42",
            "upload_time_iso_8601": "2025-07-10T15:36:42.293701Z",
            "url": "https://files.pythonhosted.org/packages/02/b1/234b372afe8504f2a0f144c4f120beae171b1102cd866a44eaa900103852/choreo-1.0.0rc0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7b2d591e700b8ba769c63279b6f85fffa39636bf856988a07c2108df5f545903",
                "md5": "1f02ffe429d756245d9ecd2fa0970c79",
                "sha256": "23c6ecef98f33d90d18bad2d88dd5b0e0dccb4427a3c159f5a75029ce389e61f"
            },
            "downloads": -1,
            "filename": "choreo-1.0.0rc0.tar.gz",
            "has_sig": false,
            "md5_digest": "1f02ffe429d756245d9ecd2fa0970c79",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 2426312,
            "upload_time": "2025-07-10T15:36:44",
            "upload_time_iso_8601": "2025-07-10T15:36:44.964875Z",
            "url": "https://files.pythonhosted.org/packages/7b/2d/591e700b8ba769c63279b6f85fffa39636bf856988a07c2108df5f545903/choreo-1.0.0rc0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 15:36:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gabrielfougeron",
    "github_project": "choreo",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "choreo"
}
        
Elapsed time: 0.96433s