diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml index 77cbf2c..dc3c4e7 100644 --- a/.github/workflows/dev.yml +++ b/.github/workflows/dev.yml @@ -11,7 +11,7 @@ jobs: fail-fast: false matrix: os: ["ubuntu-latest"] - python-version: ["3.9", "3.8"] + python-version: ["3.10", "3.9", "3.8"] steps: - uses: actions/checkout@v2 - uses: conda-incubator/setup-miniconda@v2 @@ -55,7 +55,7 @@ jobs: uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/_build/html + publish_dir: docs/build/html - name: Build sdist and bdist shell: bash -l {0} diff --git a/README.md b/README.md index 9bfd6aa..1629a79 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,52 @@ This concludes the quickstart. There are many more visualizations and tables to See the `notebooks` and `docs` folders on [github](https://github.org/dionresearch/classgraphic) for more information +# Requirements + +- Python 3.8 or later +- numpy +- pandas +- plotly>=5.0 +- scikit-learn + +# Install + +If you use conda, create an environment named `classgraphic`, then activate it: + +- in Linux: +`source activate pilot` + +- In Windows: +`conda activate pilot` + +If you use another environment management create and activate your environment +using the normal steps. + +Then execute: + +```sh +python setup.py install +``` + +or for installing in [development mode](https://pip.pypa.io/en/latest/cli/pip_install/#install-editable): + + +```sh +python -m pip install -e . --no-build-isolation +``` + +or alternatively + +```sh +python setup.py develop +``` + +To install from github instead: +```shell +pip install git+https://github.com/dionresearch/classgraphic +``` + + # See also - [stemgraphic](https://github.com/dionresearch/stemgraphic) python package for visualization of data and text diff --git a/binder/README.md b/binder/README.md new file mode 100644 index 0000000..6d2ef38 --- /dev/null +++ b/binder/README.md @@ -0,0 +1,4 @@ +# My Binder + +The environment.yml file in this folder is for mybinder.org, to make +sure we have Python 3.8 and that this module is installed. diff --git a/binder/environment.yml b/binder/environment.yml new file mode 100644 index 0000000..4ed7b7e --- /dev/null +++ b/binder/environment.yml @@ -0,0 +1,12 @@ +name: classgraphic +channels: + - default +dependencies: + - python==3.9 + - pip + - numpy + - pandas + - plotly>=5 + - scikit-learn + - pip: + - git+https://github.com/dionresearch/classgraphic diff --git a/requirements.txt b/requirements.txt index d82e519..09738ee 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ numpy pandas -plotly -scikit-learn \ No newline at end of file +plotly>=5.0 +scikit-learn diff --git a/setup.py b/setup.py index b72498c..8395d16 100644 --- a/setup.py +++ b/setup.py @@ -24,8 +24,6 @@ "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10",