Skip to content

Commit 7c66382

Browse files
dpsheliodpshelio
committed
[info] Adds the three important files
1 parent a4d6c0e commit 7c66382

File tree

4 files changed

+144
-0
lines changed

4 files changed

+144
-0
lines changed

‎CITATION.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
To acknowledge this repository please cite our paper
3+
4+
```bibtex
5+
@article{Charlene2019,
6+
title = {Reproducible {{Brain}}},
7+
volume = {12},
8+
number = {5},
9+
journal = {Brain Technologies \& Signals},
10+
doi = {10/v5dar2},
11+
author = {{Charlene Bultoc {and} Fulanito Shrug}},
12+
month = sep,
13+
year = {2019},
14+
pages = {8-13},
15+
note = {00000}
16+
}
17+
```
18+

‎LICENSE‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2019, Charlene Bultoc and others
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
9+
1. Redistributions of source code must retain the above copyright notice, this
10+
list of conditions and the following disclaimer.
11+
12+
2. Redistributions in binary form must reproduce the above copyright notice,
13+
this list of conditions and the following disclaimer in the documentation
14+
and/or other materials provided with the distribution.
15+
16+
3. Neither the name of the copyright holder nor the names of its
17+
contributors may be used to endorse or promote products derived from
18+
this software without specific prior written permission.
19+
20+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# sagittal average
2+
3+
This is a library that calculate the averages through a sagittal plane.
4+
5+
## Installation
6+
7+
Browse to the directory where this file lives, and run:
8+
```bash
9+
pip install .
10+
```
11+
That command will download any dependencies we have
12+
13+
14+
## Usage
15+
16+
Right now we have only one function, you can use it as shown below:
17+
18+
19+
```python
20+
from sagittal_average import sagittal_brain
21+
22+
sagittal_brain.run_averages("input_file.csv", "ouput_file.csv")
23+
```
24+
25+
Or alternativaly you can run it from the terminal as:
26+
27+
```bash
28+
$ sagittal_average_run input_file.csv -o output_file.csv
29+
```
30+
31+
## Contributing
32+
33+
We accept contributions via GitHub!!
34+
35+
To install the development version, clone this repository and install it on
36+
a virtual environment
37+
38+
```bash
39+
git clone [email protected]:UCL-COMP0233-24-25/sagittal_average.git
40+
python -m venv brain
41+
. brain/bin/activate
42+
cd sagittal_average
43+
pip install -e .
44+
... code code code ...
45+
deactivate
46+
```
47+
48+
or using a conda environment as
49+
50+
```bash
51+
git clone [email protected]:UCL-COMP0233-24-25/sagittal_average.git
52+
conda create -n brain python=3.12
53+
conda activate brain
54+
cd sagittal_average
55+
pip install -e .
56+
... code code code ...
57+
conda deactivate
58+
```
59+
60+

‎pyproject.toml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,39 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "sagittal_average"
7+
description = "Calculate the averages through a sagittal plane easily."
78
version = "0.1.0"
9+
readme = { file = "README.md", content-type = "text/markdown" }
10+
license = { file = "LICENSE" }
11+
license-expression = 'BSD-3-clause'
12+
authors = [
13+
{name = "Charlene Bultoc", email = "[email protected]"},
14+
{name = "ARC Team", email = "[email protected]"},
15+
]
16+
maintainers = [
17+
{name = "ARC Team", email = "[email protected]"},
18+
]
19+
classifiers = [
20+
# Check the whole list at: https://pypi.org/classifiers/
21+
# How mature is this project? Common values are
22+
# 3 - Alpha
23+
# 4 - Beta
24+
# 5 - Production/Stable
25+
"Development Status :: 3 - Alpha",
26+
27+
# Indicate who your project is intended for
28+
"Intended Audience :: Science/Research",
29+
"Topic :: Scientific/Engineering :: Bio-Informatics",
30+
# Pick your license as you wish (see also "license" above)
31+
"License :: OSI Approved :: BSD License",
32+
# Specify the Python versions you support here.
33+
"Programming Language :: Python :: 3",
34+
"Programming Language :: Python :: 3.9",
35+
"Programming Language :: Python :: 3.13",
36+
37+
# To avoid uploading it to PiPy
38+
"Private :: Do Not Upload",
39+
]
840
dependencies = [
941
"numpy",
1042
]
@@ -21,3 +53,8 @@ dev = [
2153
"pytest >= 8",
2254
"pytest-cov",
2355
]
56+
57+
[project.urls]
58+
Documentation = "https://UCL-COMP0233-24-25.github.io/sagittal_average/"
59+
Repository = "https://github.com/UCL-COMP0233-24-25/sagittal_average.git"
60+
Issues = "https://github.com/UCL-COMP0233-24-25/sagittal_average/issues"

0 commit comments

Comments
 (0)