Skip to content
This repository was archived by the owner on Feb 26, 2025. It is now read-only.

Commit 4f25199

Browse files
authored
Merge pull request #351 from alex4200/alexdoc
Updated documentation to add the README on RTD.
2 parents 0b17fda + eb62c27 commit 4f25199

File tree

5 files changed

+135
-111
lines changed

5 files changed

+135
-111
lines changed
Lines changed: 110 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,62 @@
1-
<img src="docs/source/logo/BluePyOptBanner.png"/>
2-
3-
-----------------
4-
5-
# BluePyOpt: Blue Brain Python Optimisation Library
6-
7-
<table>
8-
<tr>
9-
<td>Latest Release</td>
10-
<td>
11-
<a href="https://pypi.org/project/bluepyopt/">
12-
<img src="https://img.shields.io/pypi/v/bluepyopt.svg" alt="latest release" />
13-
</a>
14-
</td>
15-
</tr>
16-
<tr>
17-
<td>Documentation</td>
18-
<td>
19-
<a href="https://bluepyopt.readthedocs.io/">
20-
<img src="https://readthedocs.org/projects/bluepyopt/badge/?version=latest" alt="latest documentation" />
21-
</a>
22-
</td>
23-
</tr>
24-
<tr>
25-
<td>License</td>
26-
<td>
27-
<a href="https://github.com/BlueBrain/bluepyopt/blob/master/LICENSE.txt">
28-
<img src="https://img.shields.io/pypi/l/bluepyopt.svg" alt="license" />
29-
</a>
30-
</td>
31-
</tr>
32-
<tr>
33-
<td>Build Status</td>
34-
<td>
35-
<a href="https://github.com/BlueBrain/BluePyOpt/actions">
36-
<img src="https://github.com/BlueBrain/BluePyOpt/workflows/Build/badge.svg?branch=master" alt="Actions build status" />
37-
</a>
38-
</td>
39-
</tr>
40-
<tr>
41-
<td>Coverage</td>
42-
<td>
43-
<a href="https://codecov.io/gh/BlueBrain/bluepyopt">
44-
<img src="https://codecov.io/github/BlueBrain/BluePyOpt/coverage.svg?branch=master" alt="coverage" />
45-
</a>
46-
</td>
47-
</tr>
48-
<tr>
49-
<td>Gitter</td>
50-
<td>
51-
<a href="https://gitter.im/bluebrain/bluepyopt">
52-
<img src="https://badges.gitter.im/Join%20Chat.svg"
53-
</a>
1+
|banner|
2+
3+
BluePyOpt
4+
=========
5+
6+
.. raw:: html
7+
8+
<table>
9+
<tr>
10+
<td>Latest Release</td>
11+
<td>
12+
<a href="https://pypi.org/project/bluepyopt/">
13+
<img src="https://img.shields.io/pypi/v/bluepyopt.svg" alt="latest release" />
14+
</a>
15+
</td>
16+
</tr>
17+
<tr>
18+
<td>Documentation</td>
19+
<td>
20+
<a href="https://bluepyopt.readthedocs.io/">
21+
<img src="https://readthedocs.org/projects/bluepyopt/badge/?version=latest" alt="latest documentation" />
22+
</a>
23+
</td>
24+
</tr>
25+
<tr>
26+
<td>License</td>
27+
<td>
28+
<a href="https://github.com/BlueBrain/bluepyopt/blob/master/LICENSE.txt">
29+
<img src="https://img.shields.io/pypi/l/bluepyopt.svg" alt="license" />
30+
</a>
5431
</td>
55-
</tr>
56-
</table>
32+
</tr>
33+
<tr>
34+
<td>Build Status</td>
35+
<td>
36+
<a href="https://github.com/BlueBrain/BluePyOpt/actions">
37+
<img src="https://github.com/BlueBrain/BluePyOpt/workflows/Build/badge.svg?branch=master" alt="Actions build status" />
38+
</a>
39+
</td>
40+
</tr>
41+
<tr>
42+
<td>Coverage</td>
43+
<td>
44+
<a href="https://codecov.io/gh/BlueBrain/bluepyopt">
45+
<img src="https://codecov.io/github/BlueBrain/BluePyOpt/coverage.svg?branch=master" alt="coverage" />
46+
</a>
47+
</td>
48+
</tr>
49+
<tr>
50+
<td>Gitter</td>
51+
<td>
52+
<a href="https://gitter.im/bluebrain/bluepyopt">
53+
<img src="https://badges.gitter.im/Join%20Chat.svg"
54+
</a>
55+
</td>
56+
</tr>
57+
</table>
58+
59+
5760

5861
Introduction
5962
============
@@ -77,46 +80,47 @@ Citation
7780

7881
When you use the BluePyOpt software or method for your research, we ask you to cite the following publication (**this includes poster presentations**):
7982

80-
[Van Geit W, Gevaert M, Chindemi G, Rössert C, Courcol J, Muller EB, Schürmann F, Segev I and Markram H (2016). BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience. Front. Neuroinform. 10:17. doi: 10.3389/fninf.2016.00017](http://journal.frontiersin.org/article/10.3389/fninf.2016.00017)
81-
82-
```bibtex
83-
@ARTICLE{bluepyopt,
84-
AUTHOR={Van Geit, Werner and Gevaert, Michael and Chindemi, Giuseppe and Rössert, Christian and Courcol, Jean-Denis and Muller, Eilif Benjamin and Schürmann, Felix and Segev, Idan and Markram, Henry},
85-
TITLE={BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience},
86-
JOURNAL={Frontiers in Neuroinformatics},
87-
VOLUME={10},
88-
YEAR={2016},
89-
NUMBER={17},
90-
URL={http://www.frontiersin.org/neuroinformatics/10.3389/fninf.2016.00017/abstract},
91-
DOI={10.3389/fninf.2016.00017},
92-
ISSN={1662-5196}
93-
}
94-
```
83+
`Van Geit W, Gevaert M, Chindemi G, Rössert C, Courcol J, Muller EB, Schürmann F, Segev I and Markram H (2016). BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience. Front. Neuroinform. 10:17. doi: 10.3389/fninf.2016.00017 <http://journal.frontiersin.org/article/10.3389/fninf.2016.00017>`_.
84+
85+
.. code-block::
86+
87+
@ARTICLE{bluepyopt,
88+
AUTHOR={Van Geit, Werner and Gevaert, Michael and Chindemi, Giuseppe and Rössert, Christian and Courcol, Jean-Denis and Muller, Eilif Benjamin and Schürmann, Felix and Segev, Idan and Markram, Henry},
89+
TITLE={BluePyOpt: Leveraging open source software and cloud infrastructure to optimise model parameters in neuroscience},
90+
JOURNAL={Frontiers in Neuroinformatics},
91+
VOLUME={10},
92+
YEAR={2016},
93+
NUMBER={17},
94+
URL={http://www.frontiersin.org/neuroinformatics/10.3389/fninf.2016.00017/abstract},
95+
DOI={10.3389/fninf.2016.00017},
96+
ISSN={1662-5196}
97+
}
98+
99+
95100
Support
96101
=======
97-
We are providing support using a chat channel on [Gitter](https://gitter.im/BlueBrain/BluePyOpt), or the [Github discussion page](https://github.com/BlueBrain/BluePyOpt/discussions).
102+
We are providing support using a chat channel on `Gitter <https://gitter.im/BlueBrain/BluePyOpt>`_, or the `Github discussion page <https://github.com/BlueBrain/BluePyOpt/discussions>`_.
98103

99104
News
100105
====
101106
- 2017/01/04: BluePyOpt is now considered compatible with Python 3.6+.
102107
- 2016/11/10: BluePyOpt now supports NEURON point processes. This means we can fit parameters of Adex/GIF/Izhikevich models, and also synapse models.
103108
- 2016/06/14: Started a wiki: https://github.com/BlueBrain/BluePyOpt/wiki
104109
- 2016/06/07: The BluePyOpt paper was published in Frontiers in Neuroinformatics (for link, see above)
105-
- 2016/05/03: The API documentation was moved to [ReadTheDocs](http://bluepyopt.readthedocs.io/en/latest/)
110+
- 2016/05/03: The API documentation was moved to `ReadTheDocs <http://bluepyopt.readthedocs.io/en/latest/>`_
106111
- 2016/04/20: BluePyOpt now contains the code of the IBEA selector, no need to install a BBP-specific version of DEAP anymore
107112
- 2016/03/24: Released version 1.0
108113

109114
Requirements
110115
============
111116

112-
* [Python 2.7+](https://www.python.org/download/releases/2.7/) or [Python 3.6+](https://www.python.org/downloads/release/python-360/)
113-
* [Pip](https://pip.pypa.io) (installed by default in newer versions of Python)
114-
* [Neuron 7.4+](http://neuron.yale.edu/) (compiled with Python support)
115-
* [eFEL eFeature Extraction Library](https://github.com/BlueBrain/eFEL) (automatically installed by pip)
116-
* [Numpy](http://www.numpy.org) (automatically installed by pip)
117-
* [Pandas](http://pandas.pydata.org/) (automatically installed by pip)
118-
* The instruction below are written assuming you have access to a command shell
119-
on Linux / UNIX / MacOSX / Cygwin
117+
* `Python 2.7+ <https://www.python.org/download/releases/2.7/>`_ or `Python 3.6+ <https://www.python.org/downloads/release/python-360/>`_
118+
* `Pip <https://pip.pypa.io>`_ (installed by default in newer versions of Python)
119+
* `Neuron 7.4+ <http://neuron.yale.edu/>`_ (compiled with Python support)
120+
* `eFEL eFeature Extraction Library` <https://github.com/BlueBrain/eFEL>`_ (automatically installed by pip)
121+
* `Numpy <http://www.numpy.org>`_ (automatically installed by pip)
122+
* `Pandas <http://pandas.pydata.org/>`_ (automatically installed by pip)
123+
* The instruction below are written assuming you have access to a command shell on Linux / UNIX / MacOSX / Cygwin
120124

121125
Installation
122126
============
@@ -125,16 +129,18 @@ If you want to use the ephys module of BluePyOpt, you first need to install NEUR
125129

126130
And then bluepyopt itself:
127131

128-
```bash
129-
pip install bluepyopt
130-
```
132+
133+
.. code-block:: bash
134+
135+
pip install bluepyopt
136+
131137
132138
Cloud infrastructure
133139
====================
134140

135141
We provide instructions on how to set up an optimisation environment on cloud
136142
infrastructure or cluster computers
137-
[here](https://github.com/BlueBrain/BluePyOpt/tree/master/cloud-config)
143+
`here <https://github.com/BlueBrain/BluePyOpt/tree/master/cloud-config>`_
138144

139145
Quick Start
140146
===========
@@ -147,13 +153,16 @@ model with 2 HH channels can be found at
147153

148154
https://github.com/BlueBrain/BluePyOpt/blob/master/examples/simplecell/simplecell.ipynb
149155

150-
![Landscape example](https://github.com/BlueBrain/BluePyOpt/blob/master/examples/simplecell/figures/landscape_example.png)
156+
157+
.. image:: ../../examples/simplecell/figures/landscape_example.png
158+
159+
151160
**Figure**: The solution space of a single compartmental model with two parameters: the maximal conductance of Na and K ion channels. The color represents how well the model fits two objectives: when injected with two different currents, the model has to fire 1 and 4 action potential respectively during the stimuli. Dark blue is the best fitness. The blue circles represent solutions with a perfect score.
152161

153162
Neocortical Layer 5 Pyramidal Cell
154163
----------------------------------
155164
Scripts for a more complex neocortical L5PC are in
156-
[this directory](https://github.com/BlueBrain/BluePyOpt/tree/master/examples/l5pc)
165+
`this directory <https://github.com/BlueBrain/BluePyOpt/tree/master/examples/l5pc>`__
157166

158167
With a notebook:
159168

@@ -162,30 +171,40 @@ https://github.com/BlueBrain/BluePyOpt/blob/master/examples/l5pc/L5PC.ipynb
162171
Thalamocortical Cells
163172
---------------------
164173
Scripts for 2 thalamocortical cell types are in
165-
[this directory](https://github.com/BlueBrain/BluePyOpt/tree/master/examples/thalamocortical-cell)
174+
`this directory <https://github.com/BlueBrain/BluePyOpt/tree/master/examples/thalamocortical-cell>`__
166175

167176
With a notebook:
168177

169178
https://github.com/BlueBrain/BluePyOpt/blob/master/examples/thalamocortical-cell/thalamocortical-cell_opt.ipynb
170179

171180

172181
Tsodyks-Markram Model of Short-Term Plasticity
173-
---------------------
182+
----------------------------------------------
174183
Scripts for 2 version of fitting the Tsodyks-Markram model to synaptic traces are in
175-
[this directory](https://github.com/BlueBrain/BluePyOpt/tree/master/examples/tsodyksmarkramstp)
184+
`this directory <https://github.com/BlueBrain/BluePyOpt/tree/master/examples/tsodyksmarkramstp>`__
176185

177186
With 2 notebooks:
178187

179188
https://github.com/BlueBrain/BluePyOpt/blob/master/examples/tsodyksmarkramstp/tsodyksmarkramstp.ipynb
180189
https://github.com/BlueBrain/BluePyOpt/blob/master/examples/tsodyksmarkramstp/tsodyksmarkramstp_multiplefreqs.ipynb
181190

182191
API documentation
183-
==================
184-
The API documentation can be found on [ReadTheDocs](http://bluepyopt.readthedocs.io/en/latest/).
192+
=================
193+
The API documentation can be found on `ReadTheDocs <http://bluepyopt.readthedocs.io/en/latest/>`_.
185194

186195
Funding
187196
=======
188197
This work has been partially funded by the European Union Seventh Framework Program (FP7/2007­2013) under grant agreement no. 604102 (HBP), the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 720270, 785907 (Human Brain Project SGA1/SGA2) and by the EBRAINS research infrastructure, funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).
189198
This project/research was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.
190199

191200
© 2016-2021, Blue Brain Project/EPFL
201+
202+
..
203+
The following image is also defined in the index.rst file, as the relative path is
204+
different, depending from where it is sourced.
205+
The following location is used for the github README
206+
The index.rst location is used for the docs README; index.rst also defined an end-marker,
207+
to skip content after the marker 'substitutions'.
208+
209+
.. substitutions
210+
.. |banner| image:: docs/source/logo/BluePyOptBanner.png

bluepyopt/ephys/models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ def __str__(self):
448448
def get_template_name(hoc_string):
449449
"""Find the template name from hoc_string
450450
451-
Note: this will fail if there is a begintemplate in a /* */ style
451+
Note: this will fail if there is a begintemplate in a `/* */` style
452452
comment before the real begintemplate
453453
"""
454454
for i, line in enumerate(hoc_string.split('\n')):

docs/source/conf.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
# add these directories to sys.path here. If the directory is relative to the
2121
# documentation root, use os.path.abspath to make it absolute, like shown here.
2222
sys.path.insert(0, os.path.abspath('.'))
23-
# sys.path.append('sphinxext')
2423

2524
# -- General configuration -----------------------------------------------------
2625

@@ -49,7 +48,6 @@
4948

5049
# General information about the project.
5150
project = u'bluepyopt'
52-
copyright = u'2016, BBP, EPFL'
5351

5452
# The version info for the project you're documenting, acts as replacement for
5553
# |version| and |release|, also used in various other places throughout the
@@ -103,8 +101,13 @@
103101

104102
# The theme to use for HTML and HTML Help pages. See the documentation for
105103
# a list of builtin themes.
106-
html_theme = 'sphinx_rtd_theme'
107-
# html_theme = 'haiku-bbp'
104+
html_theme = 'sphinx-bluebrain-theme'
105+
html_title = 'BluepyOpt'
106+
html_show_sourcelink = False
107+
html_theme_options = {
108+
"repo_url": "https://github.com/BlueBrain/BluePyOpt/",
109+
"repo_name": "BlueBrain/BluePyOpt"
110+
}
108111

109112
# Theme options are theme-specific and customize the look and feel of a theme
110113
# further. For a list of options available for each theme, see the

docs/source/index.rst

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,16 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
BluePyOpt
7-
=========
86
9-
The Blue Brain Python Optimisation Library (BluePyOpt) is an extensible
10-
framework for data-driven model parameter optimisation that wraps and
11-
standardises several existing open-source tools.
127
13-
It simplifies the task of creating and sharing these optimisations,
14-
and the associated techniques and knowledge.
15-
This is achieved by abstracting the optimisation and evaluation tasks
16-
into various reusable and flexible discrete elements according to established
17-
best-practices.
18-
19-
Further, BluePyOpt provides methods for setting up both small- and large-scale
20-
optimisations on a variety of platforms,
21-
ranging from laptops to Linux clusters and cloud-based compute infrastructures.
8+
.. include:: ../../README.rst
9+
:end-before: .. substitutions
2210

2311
.. toctree::
2412
:maxdepth: 3
2513

26-
api
14+
Home <self>
15+
api.rst
2716

2817
Indices and tables
2918
==================
@@ -32,3 +21,4 @@ Indices and tables
3221
* :ref:`modindex`
3322
* :ref:`search`
3423

24+
.. |banner| image:: /logo/BluePyOptBanner.png

tox.ini

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
[tox]
22
envlist = py{27,3}-{unit,functional,style}
3+
34
[gh-actions]
45
python =
56
2.7: py27
67
3.6: py3
78
3.7: py3
89
3.8: py3
910
3.9: py3
11+
1012
[testenv]
1113
envdir =
1214
py27{-unit,-functional,-style,-syntax}: {toxworkdir}/py27
1315
py3{5,6,7,8,}{-unit,-functional,-style,-syntax}: {toxworkdir}/py3
16+
docs: {toxworkdir}/docs
1417
deps =
1518
coverage
1619
flake8
@@ -42,3 +45,12 @@ commands =
4245

4346
unit: nosetests -vx -a unit --with-coverage --cover-package bluepyopt --cover-xml --cover-xml-file=cov_reports/unit.coverage.xml --cover-html --cover-html-dir=cov_reports/html/unit []
4447
functional: nosetests -vx -a !unit --with-coverage --cover-package bluepyopt --cover-xml --cover-xml-file=cov_reports/functional.coverage.xml --cover-html --cover-html-dir=cov_reports/html/functional []
48+
49+
[testenv:docs]
50+
basepython = python3.6
51+
changedir = docs
52+
deps =
53+
sphinx
54+
sphinx-bluebrain-theme
55+
commands = make html SPHINXOPTS=-W
56+
whitelist_externals = make

0 commit comments

Comments
 (0)