Skip to content

Commit 40fe1d9

Browse files
JacobTh98JacobTh98
authored
PyPi-test v0.8.2.2 (#28)
* updated setup for dev install * return class data * close HS port * renamed for EIT * Started EIS package implementation * v and readme * docstrings * ISX-3 start * ISX-3 impl start * ign developements * moved image * docu and changes * documentation * shinx lint check * shinx/img update * image * pytest 0.8.2.2 * uncomment deployment
1 parent ada11ba commit 40fe1d9

31 files changed

+1073
-67
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Build and deploy docs
2+
3+
on:
4+
push:
5+
branches: [ main, master, develop ]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
14+
- name: Set up Python
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: '3.12'
18+
19+
- name: Install dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install -r docs/requirements.txt
23+
pip install -e .
24+
25+
- name: Build Sphinx docs
26+
working-directory: docs
27+
run: make html

‎.gitignore‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
__pycache__/
21
manuals
32
error_device_logs
4-
build/
5-
dist/
63
.update_package.sh.swp
74
.eggs/
85
sciopy.egg-info/
@@ -22,3 +19,40 @@ examples/measuremet_16/*
2219
examples/measuremet_32/*
2320
sciopy/eth_*
2421
Driver
22+
ISX3-dev.ipynb
23+
update_docu.md
24+
25+
# Python
26+
__pycache__/
27+
*.py[cod]
28+
*.egg-info/
29+
dist/
30+
build/
31+
32+
# virtualenvs
33+
.env/
34+
.venv/
35+
.docs-venv/
36+
docs-venv/
37+
venv/
38+
venv*/
39+
40+
# Sphinx build outputs & doctrees
41+
docs/_build/
42+
docs/_doctrees/
43+
_build/
44+
.doctrees/
45+
46+
# Sphinx cache / temp
47+
docs/.doctrees/
48+
*.doctree
49+
50+
# OS / editor files
51+
.DS_Store
52+
Thumbs.db
53+
.idea/
54+
.vscode/
55+
56+
# pip / wheel cache (optional)
57+
pip-wheel-metadata/
58+
*.whl

‎.readthedocs.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2
2+
build:
3+
os: ubuntu-22.04
4+
tools:
5+
python: "3.12"
6+
python:
7+
install:
8+
- method: pip
9+
path: .
10+
- requirements: docs/requirements.txt
11+
requests:
12+
- type: github

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img src="https://raw.githubusercontent.com/spatialaudio/sciopy/main/doc/images/logo_sciopy.jpg" alt="Bildbeschreibung" width="200"/>
1+
<img src="https://raw.githubusercontent.com/EITLabworks/sciopy/develop/docs/_static/logo_sciopy.jpg" alt="Sciopy-logo" width="200"/>
22

33
This package offers the serial interface for communication with an EIT device from ScioSpec. Commands can be written serially and the system response can be read out. With the current version, it is possible to start and stop measurements with defined burst counts and to read out the measurement data. In addition, the measurement data is packed into a data class for better further processing.
44

‎docs/Makefile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Minimal Makefile for Sphinx
2+
SPHINXBUILD = sphinx-build
3+
SOURCEDIR = .
4+
BUILDDIR = _build
5+
6+
.PHONY: help html clean
7+
8+
help:
9+
@echo "Please use 'make <target>' where <target> is one of"
10+
@echo " html to build the documentation"
11+
@echo " clean to remove build artifacts"
12+
13+
html:
14+
$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" -a -E
15+
16+
clean:
17+
@rm -rf $(BUILDDIR)/*
18+
@echo "Cleaned build artifacts"

‎docs/_autosummary/sciopy.EIT_16_32_64_128.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
sciopy.EIT\_16\_32\_64\_128
2+
===========================
3+
4+
.. currentmodule:: sciopy
5+
6+
.. autoclass:: EIT_16_32_64_128
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~EIT_16_32_64_128.GetDeviceInfo
17+
~EIT_16_32_64_128.GetFirmwareIDs
18+
~EIT_16_32_64_128.GetMeasurementSetup
19+
~EIT_16_32_64_128.GetOutputConfiguration
20+
~EIT_16_32_64_128.PowerPlugDetect
21+
~EIT_16_32_64_128.ResetMeasurementSetup
22+
~EIT_16_32_64_128.SaveSettings
23+
~EIT_16_32_64_128.SetMeasurementSetup
24+
~EIT_16_32_64_128.SetOutputConfiguration
25+
~EIT_16_32_64_128.SoftwareReset
26+
~EIT_16_32_64_128.StartStopMeasurement
27+
~EIT_16_32_64_128.SystemMessageCallback
28+
~EIT_16_32_64_128.SystemMessageCallback_usb_fs
29+
~EIT_16_32_64_128.SystemMessageCallback_usb_hs
30+
~EIT_16_32_64_128.__init__
31+
~EIT_16_32_64_128.connect_device_FS
32+
~EIT_16_32_64_128.connect_device_HS
33+
~EIT_16_32_64_128.disconnect_device
34+
~EIT_16_32_64_128.get_data_as_matrix
35+
~EIT_16_32_64_128.init_channel_group
36+
~EIT_16_32_64_128.update_BurstCount
37+
~EIT_16_32_64_128.update_FrameRate
38+
~EIT_16_32_64_128.write_command_string
39+
40+
41+
42+
43+
44+

‎docs/_autosummary/sciopy.ISX_3.rst‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
sciopy.ISX\_3
2+
=============
3+
4+
.. currentmodule:: sciopy
5+
6+
.. autoclass:: ISX_3
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~ISX_3.Action
17+
~ISX_3.GetDeviceID
18+
~ISX_3.GetExtensionPortChannel
19+
~ISX_3.GetExtensionPortModule
20+
~ISX_3.GetFE_Settings
21+
~ISX_3.GetFPGAfirmwareID
22+
~ISX_3.GetOptions
23+
~ISX_3.GetSetup
24+
~ISX_3.GetSyncTime
25+
~ISX_3.ResetSystem
26+
~ISX_3.SetExtensionPortChannel
27+
~ISX_3.SetFE_Settings
28+
~ISX_3.SetMeasurementSetup
29+
~ISX_3.SetOptions
30+
~ISX_3.SetSetup
31+
~ISX_3.SetSyncTime
32+
~ISX_3.StartMeasure
33+
~ISX_3.SystemMessageCallback
34+
~ISX_3.__init__
35+
~ISX_3.connect_device_USB2
36+
~ISX_3.disconnect_device_USB2
37+
~ISX_3.write_command_string
38+
39+
40+
41+
42+
43+

‎docs/_autosummary/sciopy.com_util.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
sciopy.com\_util
2+
================
3+
4+
.. automodule:: sciopy.com_util
5+
6+
7+
.. rubric:: Functions
8+
9+
.. autosummary::
10+
11+
available_serial_ports
12+
bytesarray_to_byteslist
13+
bytesarray_to_float
14+
bytesarray_to_int
15+
clTbt_dp
16+
clTbt_sp
17+
del_hex_in_list
18+
parse_single_frame
19+
reshape_full_message_in_bursts
20+
single_hex_to_int
21+
split_bursts_in_frames
22+

‎docs/_autosummary/sciopy.doteit.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
sciopy.doteit
2+
=============
3+
4+
.. automodule:: sciopy.doteit
5+
6+
7+
.. rubric:: Functions
8+
9+
.. autosummary::
10+
11+
convert_fulldir_doteit_to_npz
12+
convert_fulldir_doteit_to_pickle
13+
doteit_in_SingleEitFrame
14+
list_all_files
15+
list_eit_files
16+
load_pickle_to_dict
17+
single_eit_in_pickle
18+

‎docs/_autosummary/sciopy.meshing.rst‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
sciopy.meshing
2+
==============
3+
4+
.. automodule:: sciopy.meshing
5+
6+
7+
.. rubric:: Functions
8+
9+
.. autosummary::
10+
11+
add_circle_anomaly
12+
create_empty_2d_mesh
13+
mesh_sample
14+
plot_mesh
15+

0 commit comments

Comments
 (0)