<div align="center">
> **Parakeet** is a digital twin for cryo electron tomography and stands for **P**rogram for **A**nalysis and **R**econstruction of **A**rtificial data for **K**ryo **E**l**E**ctron **T**omography
[](https://pypi.python.org/pypi/python-parakeet/)
[](https://pypi.python.org/pypi/python-parakeet/)
[](https://pypi.python.org/pypi/python-parakeet/)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/python-package.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/python-publish.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/docker-publish.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/quay-io-publish.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/conda.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/snapcraft.yml)
[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/sphinx.yml)
[](https://zenodo.org/badge/latestdoi/204956111)
</div>
## Installation
Parakeet can be installed using pip with the following command:
```sh
pip install python-parakeet
```
> **_NOTE:_** Because the package needs to be built locally from source and has
some external dependencies you may need to ensure your environment is ready before
running this command. You need to set the location of the CUDA compiler and
possibly G++ and FFTW libraries. For full instructions please see the
installation documentation
[here](https://rosalindfranklininstitute.github.io/parakeet/installation.html).
## Usage
Parakeet can be used as a suite of command line tools as follows:
```sh
parakeet.config.new -c config.yaml
parakeet.sample.new -c config.yaml
parakeet.sample.add_molecules -c config.yaml
parakeet.simulate.exit_wave -c config.yaml
parakeet.simulate.optics -c config.yaml
parakeet.simulate.image -c config.yaml
```
For full command line usage instructions please see the command line
documentation here
[here](https://rosalindfranklininstitute.github.io/parakeet/usage.html).
Alternatively, there is a complementary high level Python API which can be seen
[here](https://rosalindfranklininstitute.github.io/parakeet/api.html).
## Documentation
Checkout the [documentation](https://rosalindfranklininstitute.github.io/parakeet/) for more information!
## Notifications
You can receive notifications from the [Github discussions](https://github.com/rosalindfranklininstitute/parakeet/discussions)
by clicking "watch" on this repository.
## Issues
Please use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/parakeet/issues) to submit bugs or request features.
## Changes
Checkout the [changelog](CHANGES.rst) for a list of recent changes to parakeet.
## Contributions
If you would like to help contribute to profet, please read our [contribution](CONTRIBUTING.md) guide and [code of conduct](CODE_OF_CONDUCT.md).
## License
Copyright Diamond Light Source and Rosalind Franklin Institute, 2019.
Distributed under the terms of the GPLv3 license, parakeet is free and open source software.
Raw data
{
"_id": null,
"home_page": "https://github.com/rosalindfranklininstitute/parakeet",
"name": "python-parakeet",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "MULTEM",
"author": "James Parkhurst",
"author_email": "james.parkhurst@diamond.ac.uk",
"download_url": "https://files.pythonhosted.org/packages/d7/23/3f879b347edc88d65cc71e2050f05d1c65499ba1e7111390e5fda4d3436f/python-parakeet-0.5.1.tar.gz",
"platform": "unix",
"description": "<div align=\"center\">\n\n\n\n> **Parakeet** is a digital twin for cryo electron tomography and stands for **P**rogram for **A**nalysis and **R**econstruction of **A**rtificial data for **K**ryo **E**l**E**ctron **T**omography\n\n\n[](https://pypi.python.org/pypi/python-parakeet/)\n[](https://pypi.python.org/pypi/python-parakeet/)\n[](https://pypi.python.org/pypi/python-parakeet/)\n\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/python-package.yml)\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/python-publish.yml)\n\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/docker-publish.yml)\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/quay-io-publish.yml)\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/conda.yml)\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/snapcraft.yml)\n\n[](https://github.com/rosalindfranklininstitute/parakeet/actions/workflows/sphinx.yml)\n[](https://zenodo.org/badge/latestdoi/204956111)\n\n</div>\n\n## Installation\n\nParakeet can be installed using pip with the following command:\n\n```sh\n pip install python-parakeet\n```\n\n> **_NOTE:_** Because the package needs to be built locally from source and has\nsome external dependencies you may need to ensure your environment is ready before\nrunning this command. You need to set the location of the CUDA compiler and\npossibly G++ and FFTW libraries. For full instructions please see the\ninstallation documentation\n[here](https://rosalindfranklininstitute.github.io/parakeet/installation.html).\n\n## Usage\n\nParakeet can be used as a suite of command line tools as follows:\n\n```sh\n parakeet.config.new -c config.yaml\n parakeet.sample.new -c config.yaml\n parakeet.sample.add_molecules -c config.yaml\n parakeet.simulate.exit_wave -c config.yaml\n parakeet.simulate.optics -c config.yaml\n parakeet.simulate.image -c config.yaml\n```\n\nFor full command line usage instructions please see the command line\ndocumentation here\n[here](https://rosalindfranklininstitute.github.io/parakeet/usage.html).\nAlternatively, there is a complementary high level Python API which can be seen\n[here](https://rosalindfranklininstitute.github.io/parakeet/api.html).\n\n## Documentation\n\nCheckout the [documentation](https://rosalindfranklininstitute.github.io/parakeet/) for more information!\n\n## Notifications\n\nYou can receive notifications from the [Github discussions](https://github.com/rosalindfranklininstitute/parakeet/discussions)\nby clicking \"watch\" on this repository.\n\n## Issues\n\nPlease use the [GitHub issue tracker](https://github.com/rosalindfranklininstitute/parakeet/issues) to submit bugs or request features.\n\n## Changes\n\nCheckout the [changelog](CHANGES.rst) for a list of recent changes to parakeet.\n\n## Contributions\n\nIf you would like to help contribute to profet, please read our [contribution](CONTRIBUTING.md) guide and [code of conduct](CODE_OF_CONDUCT.md).\n\n## License\n\nCopyright Diamond Light Source and Rosalind Franklin Institute, 2019.\n\nDistributed under the terms of the GPLv3 license, parakeet is free and open source software.\n\n",
"bugtrack_url": null,
"license": "GPL v3",
"summary": "A phantom generator",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/rosalindfranklininstitute/parakeet",
"Source": "https://github.com/rosalindfranklininstitute/parakeet",
"Tracker": "https://github.com/rosalindfranklininstitute/parakeet/issues"
},
"split_keywords": [
"multem"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7233f879b347edc88d65cc71e2050f05d1c65499ba1e7111390e5fda4d3436f",
"md5": "546fd60c99b238c72a7c6dd864b2b8db",
"sha256": "e73e972394753b84d7885b3a029f3b2c8d835203a3b7d014db6e4da096ae92b7"
},
"downloads": -1,
"filename": "python-parakeet-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "546fd60c99b238c72a7c6dd864b2b8db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9310964,
"upload_time": "2024-01-25T11:24:47",
"upload_time_iso_8601": "2024-01-25T11:24:47.109097Z",
"url": "https://files.pythonhosted.org/packages/d7/23/3f879b347edc88d65cc71e2050f05d1c65499ba1e7111390e5fda4d3436f/python-parakeet-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-25 11:24:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rosalindfranklininstitute",
"github_project": "parakeet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "python-parakeet"
}
JSON
