diff --git a/.gitignore b/.gitignore index b9e2ad9..ed34177 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ docs/source/gumbi htmlcov *_backup* nupack/* +dist/* +*.pub diff --git a/README.md b/README.md index 7dfe210..d43c573 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,7 @@ Read in some data and store it as a Gumbi `DataSet`: import gumbi as gmb import seaborn as sns cars = sns.load_dataset('mpg').dropna() - -ds = gmb.DataSet(cars, - outputs=['mpg', 'acceleration'], - log_vars=['mpg', 'acceleration', 'weight', 'horsepower', 'displacement']) +ds = gmb.DataSet(cars, outputs=['mpg', 'acceleration'], log_vars=['mpg', 'acceleration', 'weight', 'horsepower', 'displacement']) ``` Create a Gumbi `GP` object and fit a model that predicts *mpg* from *horsepower*: @@ -38,7 +35,6 @@ Make predictions and plot! ```python X = gp.prepare_grid() y = gp.predict_grid() - gmb.ParrayPlotter(X, y).plot() ``` @@ -46,6 +42,12 @@ More complex GPs are also possible, such as correlated multi-input and multi-out ## Installation +### Via pip + +`pip install gumbi` + +### Bleeding edge + * Clone the repo and navigate to the new directory * `git clone https://gitlab.com/JohnGoertz/gumbi gumbi` * `cd gumbi` diff --git a/environment.yml b/environment.yml index 9572a9a..26d07a4 100644 --- a/environment.yml +++ b/environment.yml @@ -14,3 +14,5 @@ dependencies: - uncertainties - ipympl - mkl + - pip: + - . diff --git a/setup.py b/setup.py index c02c7bb..f6ba923 100644 --- a/setup.py +++ b/setup.py @@ -6,8 +6,8 @@ DESCRIPTION = "Gaussian Process Model Building Interface" AUTHOR = "John Goertz" AUTHOR_EMAIL = "" -URL = "" -LICENSE = "" +URL = "https://github.com/JohnGoertz/Gumbi" +LICENSE = "Apache 2.0" PROJECT_ROOT = pl.Path(__file__).resolve().parent REQUIREMENTS = PROJECT_ROOT / "requirements.txt" @@ -28,6 +28,7 @@ "Intended Audience :: Science/Research", "Topic :: Scientific/Engineering", "Topic :: Scientific/Engineering :: Mathematics", + "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", ] @@ -37,7 +38,10 @@ author="John Goertz", author_email="", description=DESCRIPTION, + long_description_content_type="text/markdown", long_description=long_description, + url=URL, + license=LICENSE, python_requires='>=3.9', packages=find_packages(), package_data={'': ['*.pkl', '*.mplstyle']},