Skip to content

Commit a73d0f9

Browse files
committed
Update README with Contributing and License sections
Added new sections for Contributing and License, updated the navigation links, and moved the Citation section to the end. Also fixed the Miniconda download URL in the Developer Installation instructions.
1 parent b7857ce commit a73d0f9

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313
| [**Documentation**](#documentation)
1414
| [**Usage Example**](#usage-example)
1515
| [**Installation**](#installation)
16-
| [**Citation**](#citation)
1716
| [**Developer Installation**](#developer-installation)
17+
| [**Contributing**](#contributing)
18+
| [**License**](#license)
19+
| [**Citation**](#citation)
1820

1921
## What is spectral_connectivity?
2022

@@ -66,12 +68,6 @@ See the documentation on [ReadTheDocs](https://spectral-connectivity.readthedocs
6668

6769
For a canonical reference of connectivity metric value ranges, see [Connectivity Metric Ranges](docs/CONNECTIVITY_METRIC_RANGES.md).
6870

69-
### Citation
70-
71-
For citation, please use the following:
72-
73-
> Denovellis, E.L., Myroshnychenko, M., Sarmashghi, M., and Stephen, E.P. (2022). Spectral Connectivity: a python package for computing multitaper spectral estimates and frequency-domain brain connectivity measures on the CPU and GPU. JOSS 7, 4840. [10.21105/joss.04840](https://doi.org/10.21105/joss.04840).
74-
7571
### Implemented Measures
7672

7773
Functional
@@ -129,7 +125,7 @@ If you want to make contributions to this library, please use this installation.
129125
1. Install miniconda (or anaconda) if it isn't already installed. Type into bash (or install from the anaconda website):
130126

131127
```bash
132-
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
128+
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
133129
bash miniconda.sh -b -p $HOME/miniconda
134130
export PATH="$HOME/miniconda/bin:$PATH"
135131
hash -r
@@ -166,6 +162,27 @@ twine upload dist/*
166162

167163
The version number is automatically extracted from the git tag (without the 'v' prefix).
168164

165+
## Contributing
166+
167+
We welcome contributions to `spectral_connectivity`! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on:
168+
169+
+ How to report bugs and request features
170+
+ Development workflow and coding standards
171+
+ Testing requirements
172+
+ Code review process
173+
174+
For questions or discussions, please open an issue on GitHub.
175+
176+
## License
177+
178+
This project is licensed under the **GPL-3.0** License - see the [LICENSE](LICENSE) file for details.
179+
180+
## Citation
181+
182+
For citation, please use the following:
183+
184+
> Denovellis, E.L., Myroshnychenko, M., Sarmashghi, M., and Stephen, E.P. (2022). Spectral Connectivity: a python package for computing multitaper spectral estimates and frequency-domain brain connectivity measures on the CPU and GPU. JOSS 7, 4840. [10.21105/joss.04840](https://doi.org/10.21105/joss.04840).
185+
169186
### Recent publications and pre-prints that used this software
170187

171188
+ Detection of Directed Connectivities in Dynamic Systems for Different Excitation Signals using Spectral Granger Causality <https://doi.org/10.1007/978-3-662-58485-9_11>

0 commit comments

Comments
 (0)