{"id":18318443,"url":"https://github.com/oceanstreamio/oceanstream","last_synced_at":"2026-03-07T02:33:59.429Z","repository":{"id":198901895,"uuid":"686871274","full_name":"OceanStreamIO/oceanstream","owner":"OceanStreamIO","description":"Oceanstream is a Python library which can be used as a CLI tool to process raw acoustic data from echosounders. It  uses echopype as a backend. Developed at @pineviewlabs","archived":false,"fork":false,"pushed_at":"2024-08-31T11:01:44.000Z","size":327,"stargazers_count":5,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2025-10-13T14:37:06.530Z","etag":null,"topics":["acoustics","echopype","echosounder","ecology","netcdf","oceanography","sonar","underwater-acoustics","zarr"],"latest_commit_sha":null,"homepage":"https://oceanstream.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OceanStreamIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-04T06:01:45.000Z","updated_at":"2025-05-05T21:03:19.000Z","dependencies_parsed_at":"2024-08-17T10:25:03.078Z","dependency_job_id":"c66a51e5-86e6-499d-bcde-19f9f04b10a0","html_url":"https://github.com/OceanStreamIO/oceanstream","commit_stats":{"total_commits":96,"total_committers":6,"mean_commits":16.0,"dds":0.6979166666666667,"last_synced_commit":"5f340f668d82745c90deb002def73e609c302a03"},"previous_names":["oceanstreamio/oceanstream"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/OceanStreamIO/oceanstream","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Foceanstream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Foceanstream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Foceanstream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Foceanstream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OceanStreamIO","download_url":"https://codeload.github.com/OceanStreamIO/oceanstream/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Foceanstream/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30206070,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"online","status_checked_at":"2026-03-07T02:00:06.765Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acoustics","echopype","echosounder","ecology","netcdf","oceanography","sonar","underwater-acoustics","zarr"],"created_at":"2024-11-05T18:09:37.833Z","updated_at":"2026-03-07T02:33:59.408Z","avatar_url":"https://github.com/OceanStreamIO.png","language":"Python","readme":"# OceanStream\n\n[OceanStream](https://oceanstream.io/) is an integrated cloud data platform used for hydroacoustic data collection and analysis in real-time. It is built on [Azure IoT Edge](https://azure.microsoft.com/en-us/products/iot-edge) infrastructure.\n\n\u003ca href=\"https://oceanstream.io/\" target=\"_blank\"\u003e\u003cimg width=\"1537\" alt=\"OceanStream.io\" src=\"https://github.com/OceanStreamIO/oceanstream-cli/assets/419506/a1e5ecc6-77d6-45ea-ac4c-51ca1378acd2\"\u003e\u003c/a\u003e\n\n## How to Install\n\n### Prerequisites\n\n- **Python 3.11**: Ensure Python 3.11 is installed on your system.\n\n### Setup\n\nTo contribute, clone the OceanStream repository's dev branch, which contains the latest development changes:\n\n    git clone -b dev https://github.com/OceanStreamIO/oceanstream.git\n\nNavigate to the oceanstream directory:\n\n    cd oceanstream\n\nNow, you can install dependencies, run tests, or start development! Direct all pull requests to the dev branch.\n\n### Using Conda/Mamba\n\n- **Create a virtual environment to use the package:**\n    ```bash\n    conda env create -f environment.yml\n    ```\nThis command creates an environment named `oceanstream`. To activate it:\n    ```\n    conda activate oceanstream\n    ```\n- **Create a virtual environment to contribute to the package:**\n    ```bash\n    conda env create -f environment-dev.yml\n    ```\nAgain, activate the environment with:\n    ```\n    conda activate oceanstream\n    ```\n### Using Pip\n\n1. **Create a Virtual Environment:**\n    ```bash\n    python -m venv .venv\n    ```\nThis command creates a virtual environment in the `.venv` directory using Python 3.9.\n\n- **Example using `pyenv`:**\n\n    - Install Python 3.9 with `pyenv`:\n        ```bash\n        pyenv install 3.9\n        ```\n    - Navigate to your project directory:\n        ```bash\n        cd /path/to/your/project_directory\n        ```\n    - Create the virtual environment using the Python 3.9 executable managed by `pyenv`:\n        ```bash\n        ~/.pyenv/versions/3.11/bin/python -m venv .venv\n        ```\n2. **Activate the Virtual Environment:**\n\n- On Linux and MacOS:\n    ```bash\n    source .venv/bin/activate\n    ```\n- On Windows:\n    ```bash\n    .venv\\Scripts\\activate.bat  # In cmd.exe\n    .venv\\Scripts\\Activate.ps1  # In PowerShell\n    ```\n3. **Install the Dependencies:**\n\n- To use the package:\n    ```bash\n    pip install -r requirements.txt\n    ```\n- To contribute to the package:\n    ```bash\n    pip install -r requirements-dev.txt\n    ```\n## Running Pre-Commit Locally\n\n### Installation\n\nInstall the pre-commit tool using pip:\n\n    pip install pre-commit\n\n### Installing the Git Hook Scripts\n\nNavigate to your repository where the `.pre-commit-config.yaml` file is located. Install the Git hook scripts with:\n\n    pre-commit install\n\n### Running Pre-Commit\n\nPre-commit will now run automatically every time you attempt to make a commit. If any hooks fail, the commit will be blocked, and you'll be prompted to fix the issues before committing again.\n\nTo manually run all hooks against all the files, use:\n\n    pre-commit run --all-files\n\n### Updating Hooks\n\nTo update your hooks to the latest versions, use:\n\n    pre-commit autoupdate\n\n### Skipping Hooks\n\nTo bypass the hooks for a particular commit, use the `-n` or `--no-verify` option:\n\n    git commit -m \"Your commit message\" -n\n\n### Uninstalling Pre-Commit\n\nTo uninstall the Git hook scripts, use:\n\n    pre-commit uninstall\n\n## Building Documentation Locally\n\n### Prerequisites\n\nEnsure Python and pip are installed on your system.\n\n### Steps\n\n1. **Install Sphinx:**\n\n    pip install sphinx\n\n2. **Navigate to Your Project's docs Directory:**\n\n    cd /path/to/your/docs_directory\n\n3. **Build the Documentation:**\n\n- For Linux/Mac:\n\n    make html\n\n- For Windows:\n\n    make.bat html\n\nThis command will generate the HTML documentation in the `build/html` directory within your docs folder.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Foceanstream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanstreamio%2Foceanstream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Foceanstream/lists"}