circaPy 0.1.5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- circaPy/.idea/actigraphy_analysis.iml +11 -0
- circaPy/.idea/misc.xml +4 -0
- circaPy/.idea/modules.xml +8 -0
- circaPy/.idea/vcs.xml +6 -0
- circaPy/.idea/workspace.xml +95 -0
- circaPy/__init__.py +0 -0
- circaPy/activity.py +391 -0
- circaPy/episodes.py +505 -0
- circaPy/periodogram.py +101 -0
- circaPy/plots.py +351 -0
- circaPy/preprocessing.py +261 -0
- circaPy/sleep_process.py +96 -0
- circapy-0.1.5.dist-info/METADATA +104 -0
- circapy-0.1.5.dist-info/RECORD +16 -0
- circapy-0.1.5.dist-info/WHEEL +4 -0
- circapy-0.1.5.dist-info/licenses/LICENSE +674 -0
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: circaPy
|
|
3
|
+
Version: 0.1.5
|
|
4
|
+
Summary: For analysing circadian activity data
|
|
5
|
+
Project-URL: Homepage, https://github.com/A-Fisk/circaPy
|
|
6
|
+
Project-URL: Issues, https://github.com/A-Fisk/circaPy/issues
|
|
7
|
+
Author-email: Angus Fisk <angus_fisk@hotmail.com>
|
|
8
|
+
Keywords: circadian
|
|
9
|
+
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
|
|
10
|
+
Classifier: Operating System :: MacOS
|
|
11
|
+
Classifier: Programming Language :: Python :: 3
|
|
12
|
+
Requires-Python: >=3.9
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
[](https://travis-ci.org/A-Fisk/actigraphy_analysis)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
# CircaPy
|
|
19
|
+
|
|
20
|
+
CircaPy is a python module for circadian analysis of activity data.
|
|
21
|
+
It was developed using laboratory
|
|
22
|
+
rodents data but is applicable across species and monitoring devices.
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
## Getting Started
|
|
26
|
+
|
|
27
|
+
Before you continue you need an installation of Anaconda, available
|
|
28
|
+
[here](https://www.anaconda.com/download).
|
|
29
|
+
|
|
30
|
+
Then in a terminal of your choice run the following
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
pip install git+https://github.com/A-Fisk/circaPy.git@main
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This will install circaPy in your current python environment.
|
|
37
|
+
Package dependencies are listed in the environment.yml file
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
## Using circaPy
|
|
41
|
+
|
|
42
|
+
circaPy provides a set of functions to analyse and plot the most common
|
|
43
|
+
methods of circadian analysis.
|
|
44
|
+
|
|
45
|
+
Create some test data
|
|
46
|
+
```
|
|
47
|
+
import pandas as pd
|
|
48
|
+
import numpy as np
|
|
49
|
+
import circaPy.activity as act
|
|
50
|
+
|
|
51
|
+
# Create a sample dataset with time-series activity data
|
|
52
|
+
index = pd.date_range(start='2024-01-01', periods=86400, freq="10s")
|
|
53
|
+
values = np.random.randint(0, 100, size=(len(index),2))
|
|
54
|
+
|
|
55
|
+
df = pd.DataFrame(values, index=index)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Calculate IV
|
|
59
|
+
```
|
|
60
|
+
# Use circaPy's calculate_IV function to compute Interdaily Variability
|
|
61
|
+
iv = act.calculate_IV(df)
|
|
62
|
+
|
|
63
|
+
# Print the result
|
|
64
|
+
print(f"Interdaily Variability (IV): {iv:.4f}")
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Plot actogram
|
|
68
|
+
```
|
|
69
|
+
# Use circaPy plot_actogram
|
|
70
|
+
import circaPy.actogram_plot as actp
|
|
71
|
+
|
|
72
|
+
actp.plot_actogram(df, showfig=True)
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
## Contributing
|
|
78
|
+
|
|
79
|
+
1. Fork this repository
|
|
80
|
+
2. Create branch `git checkout -b <branch-name>
|
|
81
|
+
3. Create conda environment
|
|
82
|
+
```
|
|
83
|
+
conda env create -f environment.yml
|
|
84
|
+
conda activate actipy_env
|
|
85
|
+
```
|
|
86
|
+
4. Make your changes and commit them `git commit -m <commit-message>
|
|
87
|
+
- ensure test suite is passing by running `make all`
|
|
88
|
+
5. Push to the original branch `git push origin <project_name>/<location>`
|
|
89
|
+
6. Create pull request
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
## Authors
|
|
93
|
+
|
|
94
|
+
- Angus Fisk
|
|
95
|
+
- [angus_fisk@hotmail.com](angus_fisk@hotmail.com)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Licence
|
|
99
|
+
|
|
100
|
+
- Available under GNU general public licence
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
circaPy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
+
circaPy/activity.py,sha256=1goy_XkUt5OhcoPPOe1CpgCORVJ8FhARNw8LnQL7GyA,11941
|
|
3
|
+
circaPy/episodes.py,sha256=BGQxqW67swmXpNH-aeLhZ_67EgvpEp7Ha1H_KbHYXwM,16472
|
|
4
|
+
circaPy/periodogram.py,sha256=yH_CW0dfuxQfF9_xHcS2p_i5YCLuMJIN4Z7MZtp13ZI,3478
|
|
5
|
+
circaPy/plots.py,sha256=dYa3jKUQNj0QY8ERHUk1NLXIMnGF5mVkuM6C5xN2TL0,11879
|
|
6
|
+
circaPy/preprocessing.py,sha256=vu9wQSzdGmxrLWhbUU5h2ahtPq-kRFnIaiB-rq10beI,8286
|
|
7
|
+
circaPy/sleep_process.py,sha256=oh2rZl8UBg2kLXxLw6mbYE3S5vIZxZla_Cap68Cjh2w,2677
|
|
8
|
+
circaPy/.idea/actigraphy_analysis.iml,sha256=6GnoPxQ6gF69BtdpKK3mmgHwqmzJglmUa9iI5jVDo6c,398
|
|
9
|
+
circaPy/.idea/misc.xml,sha256=d8VH1GDzWGVVZo58O51-wfPY_Il-rQ9exolep12oV74,219
|
|
10
|
+
circaPy/.idea/modules.xml,sha256=ELB75pyQII1uEhIxCoEuFJWB5wlJfhAAuDpZkYE5xxU,290
|
|
11
|
+
circaPy/.idea/vcs.xml,sha256=JpBk9bpzB9zTGgO1xpBpizRCwPACTBNYNhVC9J9VCa4,183
|
|
12
|
+
circaPy/.idea/workspace.xml,sha256=2Tgp-vpRFqxCebvXxnPuUCfbcshS26qZ-5jMneikRpM,4178
|
|
13
|
+
circapy-0.1.5.dist-info/METADATA,sha256=PpZ__VfHVxQyjV1rc60f_JrIXEISrpijv3JQH36qFK8,2552
|
|
14
|
+
circapy-0.1.5.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
|
|
15
|
+
circapy-0.1.5.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
|
|
16
|
+
circapy-0.1.5.dist-info/RECORD,,
|