Skip to content
This repository has been archived by the owner. It is now read-only.

Commit d5929e1

Browse files
authored
Update README for version 0.4.0
1 parent 4e0e6c3 commit d5929e1

1 file changed

Lines changed: 47 additions & 2 deletions

File tree

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
1-
# NeuroAnnotation toolbox (NAT)
1+
[Getting started](#getting-started) |
2+
[Releases](#releases) |
3+
[Status](#status)
24

3-
This project is a sprout from the NeuroCurator project which has been divided in a front-end (NeuroCurator) and a back-end (NAT) to provide more flexibility for programmatic interaction with created annotation corpora. This toolbox provides the necessary functions and utilities to reliably annotate the neuroscientific literature, curate published values for modeling parameters, and save them in reusable corpora.
5+
# NeuroAnnotation Toolbox (NAT)
6+
7+
Python package to use the annotations created with [NeuroCurator](https://github.com/BlueBrain/neurocurator), for example in a [Jupyter](https://jupyter.org/) notebook.
8+
9+
This framework has been described in details in the following open-access paper: https://doi.org/10.3389/fninf.2017.00027.
10+
11+
NAT provides the necessary functions and utilities to reliably annotate the neuroscientific literature, curate published values for modeling parameters, and save them in reusable corpora.
12+
13+
---
14+
15+
## Getting started
16+
17+
Install the latest version with:
18+
```
19+
pip install git+https://github.com/BlueBrain/nat
20+
```
21+
22+
Install a specific version with:
23+
```
24+
pip install git+https://github.com/BlueBrain/nat.git@<tag>
25+
```
26+
(ex. '@v0.4.0')
27+
28+
NB: You don't need to install NAT to use a packaged executable of NeuroCurator.
29+
30+
## Releases
31+
32+
In the [dedicated section](https://github.com/BlueBrain/nat/releases/), you can find:
33+
- the latest version,
34+
- the notable changes of each version.
35+
36+
Releases are synchronized with the ones of NeuroCurator.
37+
38+
## Status
39+
40+
Created during 2016.
41+
42+
Ongoing reengineering in the branch _refactor-architecture_.
43+
44+
The branch _refactor-architecture_ is **not** intended to be used by end-users.
45+
46+
New features, bug fixes and improvements are done on the reengineered code sections.
47+
48+
When a reengineered code section is stable, it's merged into the branch _master_ and a release is published.

0 commit comments

Comments
 (0)