This repository has been archived by the owner. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
47 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,48 @@ | ||
# NeuroAnnotation toolbox (NAT) | ||
[Getting started](#getting-started) | | ||
[Releases](#releases) | | ||
[Status](#status) | ||
|
||
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. | ||
# NeuroAnnotation Toolbox (NAT) | ||
|
||
Python package to use the annotations created with [NeuroCurator](https://github.com/BlueBrain/neurocurator), for example in a [Jupyter](https://jupyter.org/) notebook. | ||
|
||
This framework has been described in details in the following open-access paper: https://doi.org/10.3389/fninf.2017.00027. | ||
|
||
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. | ||
|
||
--- | ||
|
||
## Getting started | ||
|
||
Install the latest version with: | ||
``` | ||
pip install git+https://github.com/BlueBrain/nat | ||
``` | ||
|
||
Install a specific version with: | ||
``` | ||
pip install git+https://github.com/BlueBrain/nat.git@<tag> | ||
``` | ||
(ex. '@v0.4.0') | ||
|
||
NB: You don't need to install NAT to use a packaged executable of NeuroCurator. | ||
|
||
## Releases | ||
|
||
In the [dedicated section](https://github.com/BlueBrain/nat/releases/), you can find: | ||
- the latest version, | ||
- the notable changes of each version. | ||
|
||
Releases are synchronized with the ones of NeuroCurator. | ||
|
||
## Status | ||
|
||
Created during 2016. | ||
|
||
Ongoing reengineering in the branch _refactor-architecture_. | ||
|
||
The branch _refactor-architecture_ is **not** intended to be used by end-users. | ||
|
||
New features, bug fixes and improvements are done on the reengineered code sections. | ||
|
||
When a reengineered code section is stable, it's merged into the branch _master_ and a release is published. |