# LISA Instrument
LISA Instrument simulates the measurement chain of LISA, including the
generation of instrumental noises, the simulation of optical signals (noises and
signals) and their interferometric detection, and the on board processing. It
delivers telemetry data.
LISA Instrument can be interfaced with other simulation tools, such as LISA
Orbits (to define constellation orbits), LISA GW Response (to inject
gravitational-wave signals), LISA Glitch (to inject instrumental artifacts),
etc.
## Physical models
A description of the underlying physical models can be found in [Unified model
for the LISA measurements and instrument simulations, Jean-Baptiste Bayle and
Olaf Hartwig, Phys. Rev. D 107, 083019
(2023)](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.107.083019).
## Contributing
### Report an issue
We use the issue-tracking management system associated with the project provided
by Gitlab. If you want to report a bug or request a feature, open an issue at
<https://gitlab.in2p3.fr/lisa-simulation/instrument/-/issues>. You may also
thumb-up or comment on existing issues.
### Development environment
We strongly recommend to use [Poetry](https://python-poetry.org) to manage your
development environment. To setup the development environment, use the following
commands:
```shell
git clone git@gitlab.in2p3.fr:lisa-simulation/instrument.git
cd instrument
poetry install
poetry shell
pre-commit install
```
### Workflow
The project's development workflow is based on the issue-tracking system
provided by Gitlab, as well as peer-reviewed merge requests. This ensures
high-quality standards.
Issues are solved by creating branches and opening merge requests. Only the
assignee of the related issue and merge request can push commits on the branch.
Once all the changes have been pushed, the "draft" specifier on the merge
request is removed, and the merge request is assigned to a reviewer. He can push
new changes to the branch, or request changes to the original author by
re-assigning the merge request to them. When the merge request is accepted, the
branch is merged onto master, deleted, and the associated issue is closed.
### Pylint and unittest
We enforce [PEP 8 (Style Guide for Python
Code)](https://www.python.org/dev/peps/pep-0008/) with Pylint syntax checking,
and correction of the code using the unittest testing framework. Both are
implemented in the continuous integration system.
You can run them locally
```shell
pylint lisainstrument
pytest
```
We use Black as a formatter.
## Authors
* Jean-Baptiste Bayle (<j2b.bayle@gmail.com>)
* Olaf Hartwig (<olaf.hartwig@obspm.fr>)
* Martin Staab (<martin.staab@aei.mpg.de>)
## Acknowledgment
We are thankful to J. Waldmann for sharing his implementation of long power-law
noise time series generators, based on [Plaszczynski, S. (2005). Generating long
streams of 1/f^alpha noise](https://doi.org/10.1142/S0219477507003635). J.
Waldmann's pyplnoise module has been included in this project as a submodule.
You can find the original project at <https://github.com/janwaldmann/pyplnoise>.
Raw data
{
"_id": null,
"home_page": "https://gitlab.in2p3.fr/lisa-simulation/instrument",
"name": "lisainstrument",
"maintainer": "Jean-Baptiste Bayle",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "j2b.bayle@gmail.com>",
"keywords": "LISA, instrument, simulation",
"author": "Jean-Baptiste Bayle",
"author_email": "j2b.bayle@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/dc/44/bd5c9e2c6ee335e6e286110df522ab830e0a0bbb5faf51fc6f8dd929921c/lisainstrument-1.9.0.tar.gz",
"platform": null,
"description": "# LISA Instrument\n\nLISA Instrument simulates the measurement chain of LISA, including the\ngeneration of instrumental noises, the simulation of optical signals (noises and\nsignals) and their interferometric detection, and the on board processing. It\ndelivers telemetry data.\n\nLISA Instrument can be interfaced with other simulation tools, such as LISA\nOrbits (to define constellation orbits), LISA GW Response (to inject\ngravitational-wave signals), LISA Glitch (to inject instrumental artifacts),\netc.\n\n## Physical models\n\nA description of the underlying physical models can be found in [Unified model\nfor the LISA measurements and instrument simulations, Jean-Baptiste Bayle and\nOlaf Hartwig, Phys. Rev. D 107, 083019\n(2023)](https://journals.aps.org/prd/abstract/10.1103/PhysRevD.107.083019).\n\n## Contributing\n\n### Report an issue\n\nWe use the issue-tracking management system associated with the project provided\nby Gitlab. If you want to report a bug or request a feature, open an issue at\n<https://gitlab.in2p3.fr/lisa-simulation/instrument/-/issues>. You may also\nthumb-up or comment on existing issues.\n\n### Development environment\n\nWe strongly recommend to use [Poetry](https://python-poetry.org) to manage your\ndevelopment environment. To setup the development environment, use the following\ncommands:\n\n```shell\ngit clone git@gitlab.in2p3.fr:lisa-simulation/instrument.git\ncd instrument\npoetry install\npoetry shell\npre-commit install\n```\n\n### Workflow\n\nThe project's development workflow is based on the issue-tracking system\nprovided by Gitlab, as well as peer-reviewed merge requests. This ensures\nhigh-quality standards.\n\nIssues are solved by creating branches and opening merge requests. Only the\nassignee of the related issue and merge request can push commits on the branch.\nOnce all the changes have been pushed, the \"draft\" specifier on the merge\nrequest is removed, and the merge request is assigned to a reviewer. He can push\nnew changes to the branch, or request changes to the original author by\nre-assigning the merge request to them. When the merge request is accepted, the\nbranch is merged onto master, deleted, and the associated issue is closed.\n\n### Pylint and unittest\n\nWe enforce [PEP 8 (Style Guide for Python\nCode)](https://www.python.org/dev/peps/pep-0008/) with Pylint syntax checking,\nand correction of the code using the unittest testing framework. Both are\nimplemented in the continuous integration system.\n\nYou can run them locally\n\n```shell\npylint lisainstrument\npytest\n```\n\nWe use Black as a formatter.\n\n## Authors\n\n* Jean-Baptiste Bayle (<j2b.bayle@gmail.com>)\n* Olaf Hartwig (<olaf.hartwig@obspm.fr>)\n* Martin Staab (<martin.staab@aei.mpg.de>)\n\n## Acknowledgment\n\nWe are thankful to J. Waldmann for sharing his implementation of long power-law\nnoise time series generators, based on [Plaszczynski, S. (2005). Generating long\nstreams of 1/f^alpha noise](https://doi.org/10.1142/S0219477507003635). J.\nWaldmann's pyplnoise module has been included in this project as a submodule.\nYou can find the original project at <https://github.com/janwaldmann/pyplnoise>.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Simulate the LISA measurement chain and generates telemetry data",
"version": "1.9.0",
"project_urls": {
"Documentation": "https://lisa-simulation.pages.in2p3.fr/instrument",
"Download": "https://gitlab.in2p3.fr/lisa-simulation/instrument/-/releases",
"Homepage": "https://gitlab.in2p3.fr/lisa-simulation/instrument",
"Issue Tracker": "https://gitlab.in2p3.fr/lisa-simulation/instrument/-/issues",
"Repository": "https://gitlab.in2p3.fr/lisa-simulation/instrument"
},
"split_keywords": [
"lisa",
" instrument",
" simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3485ffe22d9f628404cb698cfc6c23f2b68882bbf213bc0f952b4b4dad9c1404",
"md5": "5933bf5421deffb81c2a2fdebc835554",
"sha256": "2c5aaa54d02e3f1e01227de3ae1f73581d3a8cc6b138a46c7d788ae69c349537"
},
"downloads": -1,
"filename": "lisainstrument-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5933bf5421deffb81c2a2fdebc835554",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 40563,
"upload_time": "2025-02-21T00:02:23",
"upload_time_iso_8601": "2025-02-21T00:02:23.018099Z",
"url": "https://files.pythonhosted.org/packages/34/85/ffe22d9f628404cb698cfc6c23f2b68882bbf213bc0f952b4b4dad9c1404/lisainstrument-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc44bd5c9e2c6ee335e6e286110df522ab830e0a0bbb5faf51fc6f8dd929921c",
"md5": "848d873f8e4b0cc1a32179b3fa0f9982",
"sha256": "c3e624782e5c94eacf260ba1a41d1edc3bbe669e9689275af76c23e06b69cfb7"
},
"downloads": -1,
"filename": "lisainstrument-1.9.0.tar.gz",
"has_sig": false,
"md5_digest": "848d873f8e4b0cc1a32179b3fa0f9982",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 38938,
"upload_time": "2025-02-21T00:02:24",
"upload_time_iso_8601": "2025-02-21T00:02:24.746586Z",
"url": "https://files.pythonhosted.org/packages/dc/44/bd5c9e2c6ee335e6e286110df522ab830e0a0bbb5faf51fc6f8dd929921c/lisainstrument-1.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 00:02:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "lisainstrument"
}
JSON