# HSC3D
HSC3D: a Python package to quantify three-dimensional habitat structural complexity
## Package workflow
![Package workflow](hsc3d-flowchart.png)
## Setup environment
Install Anaconda or miniconda to your device. See more information at [this link](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html).
```
# choose your own virtual environment name
conda create -n hsc3d_test python=3.10 -y
conda activate hsc3d_test
```
## Installation
``pip install HSC3D``
## Usage
See [sample_usage.ipynb](sample_usage.ipynb) for a quick start.
## Demo case study point cloud data
[![Youtube video](http://img.youtube.com/vi/ZSOoDtyBH94/0.jpg)](http://www.youtube.com/watch?v=ZSOoDtyBH94)
## Citation
Please cite the following paper if you use HSC3D in your research:
```
Gu, Y.-F., Hu, J., Han, K., Lau, J. W. T., & Williams, G. A. (2024).
HSC3D: A Python package to quantify three-dimensional habitat structural complexity.
Methods in Ecology and Evolution, 00, 1–8.
https://doi.org/10.1111/2041-210X.14305
```
## License
Creative Commons Attribution-NonCommercial [License](https://creativecommons.org/licenses/by-nc/4.0/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Vicellken/HSC3D",
"name": "HSC3D",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "3D point clouds,structural complexity",
"author": "Hu, Jiamian; Gu, Yi-Fei",
"author_email": "guyf0601@connect.hku.hk",
"download_url": "https://files.pythonhosted.org/packages/77/bf/cabd119e1211475dc0af6f37486a2bcdea0a0315ef3b477f61ad9e938efc/HSC3D-0.2.4.tar.gz",
"platform": null,
"description": "# HSC3D\r\n\r\nHSC3D: a Python package to quantify three-dimensional habitat structural complexity\r\n\r\n## Package workflow\r\n\r\n![Package workflow](hsc3d-flowchart.png)\r\n\r\n## Setup environment\r\n\r\nInstall Anaconda or miniconda to your device. See more information at [this link](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html).\r\n\r\n```\r\n# choose your own virtual environment name\r\nconda create -n hsc3d_test python=3.10 -y\r\n\r\nconda activate hsc3d_test\r\n```\r\n\r\n## Installation\r\n\r\n``pip install HSC3D``\r\n\r\n## Usage\r\n\r\nSee [sample_usage.ipynb](sample_usage.ipynb) for a quick start.\r\n\r\n## Demo case study point cloud data\r\n\r\n[![Youtube video](http://img.youtube.com/vi/ZSOoDtyBH94/0.jpg)](http://www.youtube.com/watch?v=ZSOoDtyBH94)\r\n\r\n## Citation\r\n\r\nPlease cite the following paper if you use HSC3D in your research:\r\n\r\n```\r\nGu, Y.-F., Hu, J., Han, K., Lau, J. W. T., & Williams, G. A. (2024).\r\nHSC3D: A Python package to quantify three-dimensional habitat structural complexity.\r\nMethods in Ecology and Evolution, 00, 1\u20138.\r\nhttps://doi.org/10.1111/2041-210X.14305\r\n```\r\n\r\n## License\r\n\r\nCreative Commons Attribution-NonCommercial [License](https://creativecommons.org/licenses/by-nc/4.0/)\r\n",
"bugtrack_url": null,
"license": "Creative Commons Attribution-NonCommercial",
"summary": "HSC3D: a Python package to quantify three-dimensional habitat structural complexity",
"version": "0.2.4",
"project_urls": {
"Bug Reports": "https://github.com/Vicellken/HSC3D/issues",
"Homepage": "https://github.com/Vicellken/HSC3D",
"Source": "https://github.com/Vicellken/HSC3D"
},
"split_keywords": [
"3d point clouds",
"structural complexity"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3ec76033b50ce7676ded93c26206a532df53dea2d62baceb9c6fcccac513a93a",
"md5": "08d9b385ff5134b61a31c5c55545e340",
"sha256": "dc3016e568eef846a5dd0d4b527b7dab06967ed8d2f51113e8744cc4f078aa3d"
},
"downloads": -1,
"filename": "HSC3D-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08d9b385ff5134b61a31c5c55545e340",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 14420,
"upload_time": "2024-03-19T07:40:45",
"upload_time_iso_8601": "2024-03-19T07:40:45.063948Z",
"url": "https://files.pythonhosted.org/packages/3e/c7/6033b50ce7676ded93c26206a532df53dea2d62baceb9c6fcccac513a93a/HSC3D-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "77bfcabd119e1211475dc0af6f37486a2bcdea0a0315ef3b477f61ad9e938efc",
"md5": "799b81c820e833177b913be701bd72de",
"sha256": "7871fce2ca54d452ffbf1adbcce31296f6ba7bc8fc76c91a9ff4a143c4190968"
},
"downloads": -1,
"filename": "HSC3D-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "799b81c820e833177b913be701bd72de",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15648,
"upload_time": "2024-03-19T07:40:46",
"upload_time_iso_8601": "2024-03-19T07:40:46.810851Z",
"url": "https://files.pythonhosted.org/packages/77/bf/cabd119e1211475dc0af6f37486a2bcdea0a0315ef3b477f61ad9e938efc/HSC3D-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 07:40:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Vicellken",
"github_project": "HSC3D",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "hsc3d"
}