Skip to content

Commit

Permalink
adding improv logo to docs page and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jmxpearson committed Feb 17, 2024
1 parent 4b86b3e commit 4ac3cb9
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 5 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# improv

<img src="docs/improv_logo_horizontal.svg" style="width:40%"/>

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/)
Expand All @@ -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)

Expand All @@ -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 <a href="http://twitter.com/annedraelos" target="_blank">@annedraelos</a> or <a href="http://twitter.com/jmxpearson" target="_blank">@jmxpearson</a>.
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions docs/improv_logo_horizontal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/improv_logo_vertical.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/logo.png
Binary file not shown.

0 comments on commit 4ac3cb9

Please sign in to comment.