Updating READMEs and general cleanup

AllenInstitute · Dec 13, 2023 · 8db3ac4 · 8db3ac4
1 parent c2fee22
commit 8db3ac4
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 52 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -12,3 +12,4 @@ Credits
 * Nile Graddis @nilegraddis
 * Sergey Gratiy @sgratiy
 * Yang Yu @gnayuy
+* Sherif Soliman @sheriferson
diff --git a/README.md b/README.md
@@ -22,8 +22,6 @@ We welcome contributions! Please see our [contribution guide](https://github.com
 
 Deprecation Warning
 -------------------
-The 1.0.0 release of ipfx brings some new features, like NWB2 support, along with improvements to our documentation and testing. We will also drop support for
-- NWB1
-- Python 2
 
-Older versions of ipfx will continue to be available, but may receive only occasional bugfixes and patches.
+The 1.1.0 release of IPFX drops support for Python 3.6 which reached end of life and stopped receiving security updated on December 23, 2021.
+IPFX is now tested on Python 3.9 and higher.
diff --git a/docker/README.md b/docker/README.md
@@ -0,0 +1,21 @@
+# Docker images for on premise testing
+
+This directory contains Dockerfiles for building images for running on-prem tests that require internal Allen Institute resources. On-prem tests use GitHub self-hosted runners that will run tests on docker images built from these Dockerfiles.
+
+Our light and on-prem tests are defined in [our workflow file](../.github/workflows/github-actions-ci.yml "Link to GitHub Actions workflow for light and on-prem tests").
+
+- See [here](https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners) for more information on self-hosted runners.
+- See [here](https://docs.github.com/en/actions/hosting-your-own-runners/adding-self-hosted-runners) for more information on adding self-hosted runners to a GitHub repository.
+
+## Building images
+
+If you are an Allen Institute developer, you will have instructions on how to access the machine running the IPFX self-hosted runner.
+
+On this machine you can create the Docker image corresponding to the Python versions we test on by running:
+
+```
+cd ipfx/docker/py39
+docker build -t ipfx_py39:latest .
+```
+
+And this should be sufficient for the on-prem tests defined in our GitHub workflow to run.
diff --git a/requirements-py3.6.txt b/requirements-py3.6.txt
diff --git a/tox.ini b/tox.ini