Skip to content

Commit

Permalink
Updated setup to target pyglotaran v0.3.0 release
Browse files Browse the repository at this point in the history
In preparation for a pinned v0.3.0 release to go with the pyglotaran v0.3.0 release.

Added basic instruction to README
  • Loading branch information
jsnel committed Feb 21, 2021
1 parent 9c41dfc commit 9b518c7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 19 deletions.
23 changes: 11 additions & 12 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
MIT License

Copyright (c) 2020 GloTarAn
The MIT License (MIT)
Copyright (c) 2021 Joris Snellenburg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -9,13 +8,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# pyglotaran_extras

Supplementary package for pyglotaran with (example) plotting code.
Supplementary package for pyglotaran with (example) plotting code for use with the pyglotaran package, version 0.3.0.
Can be installed as a python package from sources, but is not released on pypi or conda.

## Installation

Prerequisites:

- Python 3.8
- Python package `pyglotaran` v0.3.0

Note for Windows Users: The easiest way to get python for Windows is via [Anaconda](https://www.anaconda.com/)

### Stable Release

To install pyglotaran_examples from sources, either clone this repository or download the latest release, then run this command in your terminal:

```shell
git clone https://github.com/glotaran/pyglotaran_extras.git
cd pyglotaran_extras
pip install -e .
```

or directly

```shell
pip install git+https://github.com/glotaran/pyglotaran_extras.git
```
10 changes: 4 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from setuptools import setup

install_requires = [
"pyglotaran>=0.2.0",
"pyglotaran>=0.3.0,<0.4.0",
"jupyterlab>=2.0.0",
"matplotlib>=3.0.0",
]
Expand All @@ -13,20 +13,18 @@

setup(
name="pyglotaran_extras",
version="0.2.0",
version="0.3.0",
description="Supplementary package for pyglotaran with (example) plotting code.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/glotaran/pyglotaran_extras",
classifiers=[
"Development Status :: 2 - Pre-Alpha",
"Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Topic :: Scientific/Engineering",
"Topic :: Scientific/Engineering :: Physics",
Expand All @@ -36,7 +34,7 @@
author_email="""[email protected]""",
license="MIT",
project_urls={
"GloTarAn Ecosystem": "http://glotaran.org",
"GloTarAn Ecosystem": "https://glotaran.org",
"Source": "https://github.com/glotaran/pyglotaran_extras",
"Tracker": "https://github.com/glotaran/pyglotaran_extras/issues",
},
Expand Down

0 comments on commit 9b518c7

Please sign in to comment.