| Name | libstempo JSON |
| Version |
2.5.0
JSON |
| download |
| home_page | None |
| Summary | A Python wrapper for tempo2 |
| upload_time | 2024-07-24 09:46:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <4,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# libstempo
[](https://github.com/vallis/libstempo/releases/latest)
[](https://pypi.org/project/libstempo/)
[](https://anaconda.org/conda-forge/libstempo)
[](https://github.com/vallis/libstempo/actions/workflows/ci_tests.yml)
[]()
[](https://github.com/vallis/libstempo/blob/master/LICENSE)
`libstempo` is a Python wrapper around the [tempo2](https://bitbucket.org/psrsoft/tempo2/src/master/) pulsar timing package.
## Installation
### conda Install
`libstempo` is installed most simply via [conda](https://docs.conda.io/en/latest/) as the `tempo` dependency
is bundled in the conda recipe. Simply use
```bash
conda install -c conda-forge libstempo
```
### pip Install
To use `libstempo` with pip (or from source), tempo2 must be installed as a prerequisite. Currently there are two recommended methods to do this.
1. Install via script.
```bash
curl -sSL https://raw.githubusercontent.com/vallis/libstempo/master/install_tempo2.sh | sh
```
This will install the tempo2 library in a local directory (`$HOME/.local`). This method is recommended if you do not need to use tempo2 directly but just need the installation for `libstempo`. You can also set the path to the install location. For example, to install in `/usr/local`, you could run:
```bash
# need sudo if installing in a restricted location
curl -sSL https://raw.githubusercontent.com/vallis/libstempo/master/install_tempo2.sh | sudo sh -s /usr/local
```
2. Install via the [instructions](https://bitbucket.org/psrsoft/tempo2/src/master/README.md) on the tempo2 homepage. If this method is used, the `TEMPO2` environment variable will need to be set to use `libstempo`.
In either case, it is best practice to set the `TEMPO2` environment
variable so that it can be easily discovered by `libstempo`.
The `libstempo` package can be installed via `pip`:
```bash
pip install libstempo
```
To use `astropy` for units:
```bash
pip install libstempo[astropy]
```
If you have installed `tempo2` in a location that is not in your path or not the default from `install_tempo2.sh`, you will need to install
`libstempo` with an environment variable (e.g. if `tempo2` is in `/opt/local/bin`)
```bash
TEMPO2_PREFIX=/opt/local pip install libstempo
```
or
```bash
export TEMPO2_PREFIX=/opt/local
pip install libstempo
```
## Usage
See [Demo Notebook 1](https://github.com/vallis/libstempo/blob/master/demo/libstempo-demo.ipynb) for basic usage and [Demo Notebook 2](https://github.com/vallis/libstempo/blob/master/demo/libstempo-toasim-demo.ipynb) for simulation usage.
Raw data
{
"_id": null,
"home_page": null,
"name": "libstempo",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Michele Vallisneri <vallis@vallis.org>",
"download_url": "https://files.pythonhosted.org/packages/b6/94/b1b9e5df5eb0c6a73151147b6fa75b01425c9233889ce4a6fd3e27dccfb2/libstempo-2.5.0.tar.gz",
"platform": null,
"description": "# libstempo\n\n[](https://github.com/vallis/libstempo/releases/latest)\n[](https://pypi.org/project/libstempo/)\n[](https://anaconda.org/conda-forge/libstempo)\n[](https://github.com/vallis/libstempo/actions/workflows/ci_tests.yml)\n\n\n[]()\n[](https://github.com/vallis/libstempo/blob/master/LICENSE)\n\n`libstempo` is a Python wrapper around the [tempo2](https://bitbucket.org/psrsoft/tempo2/src/master/) pulsar timing package.\n\n\n## Installation\n\n### conda Install\n\n`libstempo` is installed most simply via [conda](https://docs.conda.io/en/latest/) as the `tempo` dependency\nis bundled in the conda recipe. Simply use\n```bash\nconda install -c conda-forge libstempo\n```\n\n### pip Install\n\nTo use `libstempo` with pip (or from source), tempo2 must be installed as a prerequisite. Currently there are two recommended methods to do this.\n\n1. Install via script. \n ```bash\n curl -sSL https://raw.githubusercontent.com/vallis/libstempo/master/install_tempo2.sh | sh\n ```\n This will install the tempo2 library in a local directory (`$HOME/.local`). This method is recommended if you do not need to use tempo2 directly but just need the installation for `libstempo`. You can also set the path to the install location. For example, to install in `/usr/local`, you could run:\n ```bash\n # need sudo if installing in a restricted location\n curl -sSL https://raw.githubusercontent.com/vallis/libstempo/master/install_tempo2.sh | sudo sh -s /usr/local\n ``` \n2. Install via the [instructions](https://bitbucket.org/psrsoft/tempo2/src/master/README.md) on the tempo2 homepage. If this method is used, the `TEMPO2` environment variable will need to be set to use `libstempo`.\n\nIn either case, it is best practice to set the `TEMPO2` environment\nvariable so that it can be easily discovered by `libstempo`.\n\nThe `libstempo` package can be installed via `pip`:\n```bash\npip install libstempo\n```\n\nTo use `astropy` for units:\n```bash\npip install libstempo[astropy]\n```\n\nIf you have installed `tempo2` in a location that is not in your path or not the default from `install_tempo2.sh`, you will need to install \n`libstempo` with an environment variable (e.g. if `tempo2` is in `/opt/local/bin`)\n```bash\nTEMPO2_PREFIX=/opt/local pip install libstempo\n```\nor\n```bash\nexport TEMPO2_PREFIX=/opt/local\npip install libstempo\n```\n\n## Usage\n\nSee [Demo Notebook 1](https://github.com/vallis/libstempo/blob/master/demo/libstempo-demo.ipynb) for basic usage and [Demo Notebook 2](https://github.com/vallis/libstempo/blob/master/demo/libstempo-toasim-demo.ipynb) for simulation usage.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for tempo2",
"version": "2.5.0",
"project_urls": {
"Homepage": "https://github.com/vallis/libstempo"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b694b1b9e5df5eb0c6a73151147b6fa75b01425c9233889ce4a6fd3e27dccfb2",
"md5": "4480803e32ae7f0911ed7c2d42a862a4",
"sha256": "3e7621c48247a50cde0f826023bee9c251276fe9f932c75a3cb28fff38b64f58"
},
"downloads": -1,
"filename": "libstempo-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "4480803e32ae7f0911ed7c2d42a862a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 965617,
"upload_time": "2024-07-24T09:46:23",
"upload_time_iso_8601": "2024-07-24T09:46:23.956057Z",
"url": "https://files.pythonhosted.org/packages/b6/94/b1b9e5df5eb0c6a73151147b6fa75b01425c9233889ce4a6fd3e27dccfb2/libstempo-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-24 09:46:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vallis",
"github_project": "libstempo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "libstempo"
}
