Skip to content
Snippets Groups Projects
Commit a65e7cd5 authored by Sebastiano Bernuzzi's avatar Sebastiano Bernuzzi
Browse files

Update README.md

parent 4a702ba5
No related branches found
No related tags found
No related merge requests found
......@@ -10,18 +10,13 @@ The [CoRe](http://www.computational-relativity.org/) python package for the anal
The installation relies on standard Python library `setuptools`.
Once the repository is cloned, the installation can be performed in two ways,
depending on the choice of the user:
* Run the command `python setup.py install` or `python setup.py install --user` inside the project directory.
* Install the module via `pip` running the command `python -m pip install` inside the project directory. It is possible to include the `--user` option and the `-e` option for editing.
## Requirements
The Python Waveform Analysis Tools are compatible with Python3 (Old versions of watpy were Python2 compatible).
Albeit WatPy is a Python package, it requires the following to be able to properly interface with the database:
* [git](https://git-scm.com/) version control system
* [git-lfs](https://git-lfs.github.com/) API (Large File Storage)
`watpy` works with Python3.
The following Python packages are required for installation:
* [Numpy](https://numpy.org/) (Python array-handler)
......@@ -34,6 +29,12 @@ For users interested in interactive usage of this package we suggest ipyhton not
* [iPython](https://ipython.org/) (Strictly better version of the basic python shell)
* [Jupyter](https://jupyter.org/) (Notebooks, slides, HTML conversion of notebooks and more)
To sync and clone the CoRe DB `watpy` requires a git installation:
* [git](https://git-scm.com/) version control system
* [git-lfs](https://git-lfs.github.com/) API (Large File Storage)
## Content
`watpy` implements few classes to clone and work with CoRe waveforms.
......@@ -49,7 +50,7 @@ For users interested in interactive usage of this package we suggest ipyhton not
## Features
* Classes for multipolar waveform data
* Classes to work with the CoRe database
* Classes to work with the [CoRe database](core-gitlfs.tpi.uni-jena.de/)
* Gravitational-wave energy and angular momentum calculation routines
* Psi4-to-h via FFI or time integral routines
* Waveform alignment and phasing routines
......@@ -58,4 +59,4 @@ For users interested in interactive usage of this package we suggest ipyhton not
* Richardson extrapolation
* Wave objects contain already information on merger quantities (time, frequency)
* Unit conversion package
* Compatible file formats: BAM, Cactus (WhiskyTHC / FreeTHC), CoRe database
* Compatible numerical-relativity file formats: BAM, Cactus (WhiskyTHC / FreeTHC), CoRe database
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment