diff --git a/README.md b/README.md index 0770e6fe..702425c2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# improv + + + +Adaptive experiments for neuroscience +--------- + [![PyPI](https://img.shields.io/pypi/v/improv?style=flat-square?style=flat-square)](https://pypi.org/project/improv) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/improv?style=flat-square)](https://pypi.org/project/improv) [![docs](https://github.com/project-improv/improv/actions/workflows/docs.yaml/badge.svg?style=flat-square)](https://project-improv.github.io/) @@ -7,9 +12,8 @@ [![PyPI - License](https://img.shields.io/pypi/l/improv?style=flat-square)](https://opensource.org/licenses/MIT) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) -A flexible software platform for real-time and adaptive neuroscience experiments. -_improv_ is a streaming software platform designed to enable adaptive experiments. By analyzing data, such as 2-photon calcium images, as it comes in, we can obtain information about the current brain state in real time and use it to adaptively modify an experiment as data collection is ongoing. +_improv_ is a streaming software platform designed to enable adaptive experiments. By analyzing data as they arrive, we can obtain information about the current brain state in real time and use it to adaptively modify an experiment as data collection is ongoing. ![](https://dibs-files.cloud.duke.edu/sites/default/files/improvGif.gif) @@ -33,7 +37,7 @@ _improv_'s design is based on a streamlined version of the actor model for concu ## Installation -For installation instructions, please consult the [docs](https://project-improv.github.io/improv/installation.html) on our github. +For installation instructions, please consult the [documentation](https://project-improv.github.io/improv/installation.html). ### Contact To get in touch, feel free to reach out on Twitter @annedraelos or @jmxpearson. diff --git a/docs/_config.yml b/docs/_config.yml index e3881a7a..6398470a 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -8,7 +8,7 @@ title : improv documentation # The title of the book. Will be placed in the left navbar. author : improv team # The author of the book copyright : "2024" # Copyright year to be placed in the footer -logo : logo.png # A path to the book logo +logo : improv_logo_vertical.svg # A path to the book logo # Force re-execution of notebooks on each build. # See https://jupyterbook.org/content/execute.html diff --git a/docs/improv_logo_horizontal.svg b/docs/improv_logo_horizontal.svg new file mode 100644 index 00000000..57f190b2 --- /dev/null +++ b/docs/improv_logo_horizontal.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/improv_logo_vertical.svg b/docs/improv_logo_vertical.svg new file mode 100644 index 00000000..9d17a96a --- /dev/null +++ b/docs/improv_logo_vertical.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logo.png b/docs/logo.png deleted file mode 100644 index 06d56f40..00000000 Binary files a/docs/logo.png and /dev/null differ