Skip to content
Snippets Groups Projects
Commit 046eb9c2 authored by Alejandra Gonzalez's avatar Alejandra Gonzalez
Browse files

PyPi stuff

parent 744b03df
No related branches found
No related tags found
No related merge requests found
LICENSE 0 → 100644
This diff is collapsed.
......@@ -7,6 +7,12 @@ The [CoRe](http://www.computational-relativity.org/) python package for the anal
## Installation
### PyPi
Run the command `pip install core-watpy`. Note that to use this package one needs to type `watpy` only, e.g. `import watpy`.
### From source
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:
......@@ -24,7 +30,7 @@ The following Python packages are required for installation:
* [Matplotlib](https://matplotlib.org/) (Nice visualization package)
* [H5py](https://www.h5py.org/) (Pythonic interface to HDF5)
For users interested in interactive usage of this package we suggest ipyhton notebooks. These can be installed with the following packages:
For users interested in interactive usage of this package we suggest ipython notebooks. These can be installed with the following packages:
* [iPython](https://ipython.org/) (Strictly better version of the basic python shell)
* [Jupyter](https://jupyter.org/) (Notebooks, slides, HTML conversion of notebooks and more)
......@@ -47,6 +53,10 @@ To sync and clone the CoRe DB `watpy` requires a git installation:
* `CoRe_h5()` to work with HDF5 data, see [coredb.py](watpy/utils/coreh5.py)
* `CoRe_md()` to manage the metadata, see [metadata.py](watpy/codedb/metadata.py)
Please note that in order to use this package one needs to type `watpy` only, e.g. `import watpy`.
See [watpy_CoReDB.ipynb](https://git.tpi.uni-jena.de/core/watpy/-/blob/master/tutorials/watpy_CoReDB.ipynb) and [watpy_wave.ipynb](https://git.tpi.uni-jena.de/core/watpy/-/blob/master/tutorials/watpy_wave.ipynb) for our tutorials on the CoRe DB and waveforms.
## Features
* Classes for multipolar waveform data
......
[build-system]
requires = ["setuptools>=61.0","numpy>=1.23.1","scipy>=1.9.1","matplotlib>=3.5.3","h5py>=3.7.0"]
build-backend = "setuptools.build_meta"
[project]
name = "core-watpy"
version = "0.0.1"
authors = [
{ name="The CoRe Team", email="core@listserv.uni-jena.de" },
]
description = "Waveform Analysis Tool in Python"
readme = "README.md"
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
]
[project.urls]
"Homepage" = "https://git.tpi.uni-jena.de/core/watpy"
"Bug Tracker" = "https://git.tpi.uni-jena.de/core/watpy/-/issues"
"Mailing List" = "https://lserv.uni-jena.de/mailman/listinfo/core"
\ No newline at end of file
#!/usr/bin/env python
from setuptools import setup, find_packages
import re
# Read version from pyproject.toml
ini = open('pyproject.toml').read()
vrs = r"^version = ['\"]([^'\"]*)['\"]"
mo = re.search(vrs, ini, re.M)
version = mo.group(1)
setup(
name='watpy',
version='1.0',
name='core-watpy',
version=version,
description='Waveform Analysis Tool in Python',
author='AAVV',
author_email='core@uni-jena.de',
url = 'https://bitbucket.org/bernuzzi/watpy',
author='CoRe Team',
author_email='core@listserv.uni-jena.de',
url = 'https://git.tpi.uni-jena.de/core/watpy',
packages = find_packages(),
requires = ['h5py', 'numpy', 'matplotlib'],
)
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