diff --git a/README.md b/README.md index 7c76389..d2a2ee7 100644 --- a/README.md +++ b/README.md @@ -35,15 +35,22 @@ We provide more examples [here](examples/). ## Installing -We support Python versions 3.7 and upwards. +Install the package: -Install via git: -```python +``` +pip install git+https://github.com/davidnabergoj/normalizing-flows.git +``` + +Setup for development: + +``` git clone https://github.com/davidnabergoj/normalizing-flows.git cd normalizing-flows pip install -r requirements.txt ``` +We support Python versions 3.7 and upwards. + ## Brief background A normalizing flow (NF) is a flexible distribution, defined as a bijective transformation of a simple statistical diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3c19e0c --- /dev/null +++ b/setup.py @@ -0,0 +1,40 @@ +from setuptools import setup, find_packages +import pathlib + +here = pathlib.Path(__file__).parent.resolve() + +long_description = (here / "README.md").read_text(encoding="utf-8") + +setup( + name="normalizing-flows", + version="0.1", + description="Modern normalizing flows in Python", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/davidnabergoj/normalizing-flows", + author="David Nabergoj", + author_email="david.nabergoj@fri.uni-lj.si", + classifiers=[ # Optional + "Development Status :: 3 - Alpha", + "Intended Audience :: Science/Research", + "Topic :: Software Development :: Build Tools", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3 :: Only", + ], + keywords="sample, setuptools, development", + packages=find_packages("./"), # Required + python_requires=">=3.7, <4", + install_requires=[ + "torch>=2.0.1", + "numpy", + "torchdiffeq", + "tqdm" + ], + project_urls={ + "Bug Reports": "https://github.com/davidnabergoj/normalizing-flows/issues", + }, +)