Feature/read raw files

.github/workflows/python-test.yml

@@ -0,0 +1,44 @@
+name: Python Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    if: env.SKIP_BUILD != 'true'
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11']
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+
+    - name: Install Miniconda
+      run: |
+        wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
+        bash miniconda.sh -b -p $HOME/miniconda
+        source "$HOME/miniconda/etc/profile.d/conda.sh"
+        conda config --set always_yes yes --set changeps1 no
+        conda update -q conda
+        conda info -a
+
+    - name: Install Mamba
+      run: |
+        source "$HOME/miniconda/etc/profile.d/conda.sh"
+        conda install mamba -c conda-forge
+
+    - name: Create Environment and Install Dependencies
+      run: |
+        source "$HOME/miniconda/etc/profile.d/conda.sh"
+        mamba create -q -n test-environment python=${{ matrix.python-version }}
+        conda activate test-environment
+        mamba install pytest -c conda-forge
+
+    - name: Run Tests
+      run: |
+        source "$HOME/miniconda/etc/profile.d/conda.sh"
+        conda activate test-environment
+        pytest

.gitignore

@@ -22,6 +22,7 @@ var/
 wheels/
 share/python-wheels/
 *.egg-info/
+notebooks/
 .installed.cfg
 *.egg
 MANIFEST
@@ -158,4 +159,12 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
+# Data files
+test_data/
+*.nc
+*.zarr
+*.raw
+# For MAC stuff
+.DS_Store
+oceanstream/.DS_Store

.pre-commit-config.yaml

@@ -1,8 +1,8 @@
 exclude: |
   (?x)^(
-    echopype/tests/|
-    echopype/test_data/|
-    echopype/visualize/|
+    tests/|
+    test_data/|
+    oceanstream/visualize/|
     docs/source/conf.py
   )
 repos:
@@ -37,6 +37,6 @@ repos:
     rev: v2.2.5
     hooks:
       - id: codespell
-        # Checks spelling in `docs/source` and `echopype` dirs ONLY
+        # Checks spelling in `docs/source` and `oceanstream` dirs ONLY
         # Ignores `.ipynb` files and `_build` folders
-        args: ["--skip=*.ipynb,docs/source/_build,echopype/test_data", "-w", "docs/source", "echopype"]
+        args: ["--skip=*.ipynb,docs/source/_build,oceanstream/test_data", "-w", "docs/source", "oceanstream"]

docs/source/L0.rst

@@ -1,5 +1,5 @@
 L0_unprocessed_data module
 ==========================
 
-.. automodule:: oceanstream.L0_unprocessed_data.template
+.. automodule:: oceanstream.L0_unprocessed_data.raw_reader
    :members:

docs/source/index.rst

@@ -3,7 +3,7 @@ Oceanstream Documentation
 ===========================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    introduction

notebooks/README.md

@@ -0,0 +1 @@
+# oceanstream