hera_sim
========
|Build Status| |Coverage Status| |RTD|
**Basic simulation package for HERA-like redundant interferometric arrays.**
Features
--------
* **Systematic Models:** Many models of instrumental systematics in various forms,
eg. thermal noise, RFI, bandpass gains, cross-talk, cable reflections and foregrounds.
* **HERA-tuned:** All models have defaults tuned to HERA, with various default "sets"
available (eg.H1C, H2C)
* **Interoperability:** Interoperability with ``pyuvdata`` datasets and ``pyuvsim``
configurations.
* **Ease-of-use:** High-level interface for adding multiple systematics to existing
visibilities in a self-consistent way.
* **Visibility Simulation:** A high-level interface for visbility simulation that is
compatible with the configuration definition from ``pyuvsim`` but is able to call
multiple simulator implementations.
* **Convenience:** Methods for adjusting simulated data to match the times/baselines of
a reference dataset.
Documentation
-------------
At `ReadTheDocs <https://hera-sim.readthedocs.io/en/latest/>`_.
In particular, for a tutorial and overview of available features, check out the
`tour <https://hera-sim.readthedocs.io/en/latest/tutorials/hera_sim_tour.html>`_.
Installation
------------
Conda users
~~~~~~~~~~~
If you are using conda, the following command will install all
dependencies which it can handle natively:
``$ conda install -c conda-forge numpy scipy pyuvdata attrs h5py healpy pyyaml``
If you are creating a new development environment, consider using the
included environment file:
``$ conda env create -f ci/tests.yaml``
This will create a fresh environment with all required dependencies, as
well as those required for testing. Then follow the pip-only
instructions below to install ``hera_sim`` itself.
Pip-only install
~~~~~~~~~~~~~~~~
Simply use ``pip install -e .`` or run
``pip install git+git://github.com/HERA-Team/hera_sim``.
Developer install
~~~~~~~~~~~~~~~~~
For a development install (tests and documentation), run
``pip install -e .[dev]``.
Other optional extras can be installed as well. To use
baseline-dependent averaging functionality, install the extra ``[bda]``.
For the ability to simulate redundant gains, install ``[cal]``. To
enable GPU functionality on some of the methods (especially visibility
simulators), install ``[gpu]``.
As the repository is becoming quite large, you may also wish to perform
a shallow clone to retrieve only the recent commits and history. This makes
the clone faster and avoid bottleneck in CI pipelines.
Provide an argument ``--depth 1`` to the ``git clone`` command to copy only
the latest revision of the repository.
``git clone -–depth [depth] git@github.com:HERA-Team/hera_sim.git``
Versioning
----------
We use semantic versioning (``major``.\ ``minor``.\ ``patch``) for the
``hera_sim`` package (see `SemVer documentation <https://semver.org>`_).
To briefly summarize, new
``major`` versions include API-breaking changes, new ``minor`` versions
add new features in a backwards-compatible way, and new ``patch``
versions implement backwards-compatible bug fixes.
.. |Build Status| image:: https://github.com/HERA-Team/hera_sim/workflows/Tests/badge.svg
:target: https://github.com/HERA-Team/hera_sim
.. |Coverage Status| image:: https://coveralls.io/repos/github/HERA-Team/hera_sim/badge.svg?branch=master
:target: https://coveralls.io/github/HERA-Team/hera_sim?branch=master
.. |RTD| image:: https://readthedocs.org/projects/hera-sim/badge/?version=latest
:target: https://hera-sim.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Raw data
{
"_id": null,
"home_page": "https://github.com/HERA-Team/hera_sim",
"name": "hera-sim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "HERA Team",
"author_email": "steven.g.murray@asu.edu",
"download_url": "https://files.pythonhosted.org/packages/2c/67/0bf00561a52ee55d156d700c14bf156ef71afe722599fb61f143b9bf0d1c/hera_sim-4.2.2.tar.gz",
"platform": "any",
"description": "hera_sim\n========\n\n|Build Status| |Coverage Status| |RTD|\n\n**Basic simulation package for HERA-like redundant interferometric arrays.**\n\nFeatures\n--------\n\n* **Systematic Models:** Many models of instrumental systematics in various forms,\n eg. thermal noise, RFI, bandpass gains, cross-talk, cable reflections and foregrounds.\n* **HERA-tuned:** All models have defaults tuned to HERA, with various default \"sets\"\n available (eg.H1C, H2C)\n* **Interoperability:** Interoperability with ``pyuvdata`` datasets and ``pyuvsim``\n configurations.\n* **Ease-of-use:** High-level interface for adding multiple systematics to existing\n visibilities in a self-consistent way.\n* **Visibility Simulation:** A high-level interface for visbility simulation that is\n compatible with the configuration definition from ``pyuvsim`` but is able to call\n multiple simulator implementations.\n* **Convenience:** Methods for adjusting simulated data to match the times/baselines of\n a reference dataset.\n\nDocumentation\n-------------\n\nAt `ReadTheDocs <https://hera-sim.readthedocs.io/en/latest/>`_.\nIn particular, for a tutorial and overview of available features, check out the\n`tour <https://hera-sim.readthedocs.io/en/latest/tutorials/hera_sim_tour.html>`_.\n\nInstallation\n------------\n\nConda users\n~~~~~~~~~~~\n\nIf you are using conda, the following command will install all\ndependencies which it can handle natively:\n\n``$ conda install -c conda-forge numpy scipy pyuvdata attrs h5py healpy pyyaml``\n\nIf you are creating a new development environment, consider using the\nincluded environment file:\n\n``$ conda env create -f ci/tests.yaml``\n\nThis will create a fresh environment with all required dependencies, as\nwell as those required for testing. Then follow the pip-only\ninstructions below to install ``hera_sim`` itself.\n\nPip-only install\n~~~~~~~~~~~~~~~~\n\nSimply use ``pip install -e .`` or run\n``pip install git+git://github.com/HERA-Team/hera_sim``.\n\nDeveloper install\n~~~~~~~~~~~~~~~~~\nFor a development install (tests and documentation), run\n``pip install -e .[dev]``.\n\nOther optional extras can be installed as well. To use\nbaseline-dependent averaging functionality, install the extra ``[bda]``.\nFor the ability to simulate redundant gains, install ``[cal]``. To\nenable GPU functionality on some of the methods (especially visibility\nsimulators), install ``[gpu]``.\n\nAs the repository is becoming quite large, you may also wish to perform\na shallow clone to retrieve only the recent commits and history. This makes\nthe clone faster and avoid bottleneck in CI pipelines.\n\nProvide an argument ``--depth 1`` to the ``git clone`` command to copy only\nthe latest revision of the repository.\n\n``git clone -\u2013depth [depth] git@github.com:HERA-Team/hera_sim.git``\n\nVersioning\n----------\n\nWe use semantic versioning (``major``.\\ ``minor``.\\ ``patch``) for the\n``hera_sim`` package (see `SemVer documentation <https://semver.org>`_).\nTo briefly summarize, new\n``major`` versions include API-breaking changes, new ``minor`` versions\nadd new features in a backwards-compatible way, and new ``patch``\nversions implement backwards-compatible bug fixes.\n\n.. |Build Status| image:: https://github.com/HERA-Team/hera_sim/workflows/Tests/badge.svg\n :target: https://github.com/HERA-Team/hera_sim\n.. |Coverage Status| image:: https://coveralls.io/repos/github/HERA-Team/hera_sim/badge.svg?branch=master\n :target: https://coveralls.io/github/HERA-Team/hera_sim?branch=master\n.. |RTD| image:: https://readthedocs.org/projects/hera-sim/badge/?version=latest\n :target: https://hera-sim.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A collection of simulation routines describing the HERA instrument.",
"version": "4.2.2",
"project_urls": {
"Documentation": "https://hera_sim.readthedocs.org",
"Homepage": "https://github.com/HERA-Team/hera_sim"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d1028189232d6e7651e10d1c8a706c39901daa223431fb970f4ca1c2701f4310",
"md5": "22ecd5eb6763504b7c3c12ef84f4af9c",
"sha256": "ff237971d4b1ff263d119b972cf35a891867b6b59812922bf30d123aff0df0b8"
},
"downloads": -1,
"filename": "hera_sim-4.2.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "22ecd5eb6763504b7c3c12ef84f4af9c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 2580091,
"upload_time": "2024-04-23T20:50:51",
"upload_time_iso_8601": "2024-04-23T20:50:51.261549Z",
"url": "https://files.pythonhosted.org/packages/d1/02/8189232d6e7651e10d1c8a706c39901daa223431fb970f4ca1c2701f4310/hera_sim-4.2.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c670bf00561a52ee55d156d700c14bf156ef71afe722599fb61f143b9bf0d1c",
"md5": "f1c4ec976a7c86b8d1f92af4b0cebe38",
"sha256": "3826526a4074148a17b06e3e50c124bd07442da2ae7a09def3982351e9247144"
},
"downloads": -1,
"filename": "hera_sim-4.2.2.tar.gz",
"has_sig": false,
"md5_digest": "f1c4ec976a7c86b8d1f92af4b0cebe38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7001051,
"upload_time": "2024-04-23T20:50:56",
"upload_time_iso_8601": "2024-04-23T20:50:56.208890Z",
"url": "https://files.pythonhosted.org/packages/2c/67/0bf00561a52ee55d156d700c14bf156ef71afe722599fb61f143b9bf0d1c/hera_sim-4.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 20:50:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HERA-Team",
"github_project": "hera_sim",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "hera-sim"
}
JSON
