EcoMod


NameEcoMod JSON
Version 0.1.5 PyPI version JSON
download
home_pageNone
SummaryA simple species distribution modelling package. Functionality is currently limited to BIOCLIM.
upload_time2024-03-10 03:11:39
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords species distribution ecological niche habitat suitability
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # EcoMod
Greetings, fellow ecologists. This is a simple species distribution modelling package, with currently only having the BIOCLIM function.

## installation
Use the package manager pip to install the module.
Due to the issue of osgeo package, I've included the whl of GDAL for Win py3.11 in this package.
You might need to look for other relevant source if you're running on a different system, such as Mac.
```bash
pip install YOUR_PYTHON_FOLDER/GDAL-3.4.3-cp311-cp311-win_amd64.whl
pip install EcoMod
```

## Usage
```python
import EcoMod

# get occurrences data & WorldClim GeoTiff
bioclims = [1, 12]
# # |: repeat for testing set
coordinates = EcoMod.get_coord("sp. name")
latitudes = [i[0] for i in coordinates]
longitudes = [i[1] for i in coordinates]
EcoMod.bioclimap(coordinates, bioclims, reso=10)
# # # [1] call to get the optimum from the training set.
EcoMod.get_norm_const(coordinates)
# # :| [2] normalise the prediction (i.e., testing, present) map
clusters = EcoMod.radius_cluster(coordinates, 2) # optional
normed_array = EcoMod.normalise()

# view the prediction map using matplotlib
# # assign 'extent_84320700' (variable) to the 'extent' param
# # to crop out the Region of Focus
...
plt.imshow(normed_array, extent=extent_84320700)
plt.show()
```

## Roadmap
I'll next be working on a more advance and statistically comprehensive feature like MaxEnt and its related target group background.
The aesthetic part of the map (i.e, visualisation) is also part of the roadmap.
This project is also following the guidelines and suggestions in Soley-Guardia et al.'s (2024) publication on the top ten hazards that were seen when modelling species distribution.

## Contributing
Contributions are welcome. Feel free to open an issue for any suggestion or submit a pull request.

## License
This project is licensed under the conventional MIT License - see the LICENSE file for details.

## Acknowledgement
This eco-modelling package was inspired by Timothée Poisot's "BioClim from scratch" tutorial. Special thanks to Professor Poisot (@tpoisot) for creating such an informative guide on modelling the bioclimatic distribution of species.

## References
1. Mateo, R.G., Croat, T.B., Felicísimo, A.M. & Muñoz, J. (2010) Profile or group discriminative techniques? Generating reliable species distribution models using pseudo-absences and target-group absences from natural history collections._Diversity and Distribution_, 16(1), 84-94. https://doi.org/10.1111/j.1472-4642.2009.00617.x
2. Poisot, T. (2021) Building the BioClim model from scratch_.[\[video\]]YouTube.(https://www.youtube.com/watch?v=81MblyNWz3Q)
3. Soley-Guardia, M., Alvarado-Serrano, D.F. & Anderson, R.P. (2024) _Top ten hazards to avoid when modeling species distributions: a didactic guide of assumptions, problems, and recommendations._Ecography_, e06852. https://doi.org/10.1111/ecog.06852
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "EcoMod",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "species distribution,ecological niche,habitat suitability",
    "author": null,
    "author_email": "Wen Kang Lee <wynn.wk.lee@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/4c/a0/4dbcafd0a704a1d99d27512d7a7a66e095a5b7e579f330e105c11099536a/ecomod-0.1.5.tar.gz",
    "platform": null,
    "description": "# EcoMod\nGreetings, fellow ecologists. This is a simple species distribution modelling package, with currently only having the BIOCLIM function.\n\n## installation\nUse the package manager pip to install the module.\nDue to the issue of osgeo package, I've included the whl of GDAL for Win py3.11 in this package.\nYou might need to look for other relevant source if you're running on a different system, such as Mac.\n```bash\npip install YOUR_PYTHON_FOLDER/GDAL-3.4.3-cp311-cp311-win_amd64.whl\npip install EcoMod\n```\n\n## Usage\n```python\nimport EcoMod\n\n# get occurrences data & WorldClim GeoTiff\nbioclims = [1, 12]\n# # |: repeat for testing set\ncoordinates = EcoMod.get_coord(\"sp. name\")\nlatitudes = [i[0] for i in coordinates]\nlongitudes = [i[1] for i in coordinates]\nEcoMod.bioclimap(coordinates, bioclims, reso=10)\n# # # [1] call to get the optimum from the training set.\nEcoMod.get_norm_const(coordinates)\n# # :| [2] normalise the prediction (i.e., testing, present) map\nclusters = EcoMod.radius_cluster(coordinates, 2) # optional\nnormed_array = EcoMod.normalise()\n\n# view the prediction map using matplotlib\n# # assign 'extent_84320700' (variable) to the 'extent' param\n# # to crop out the Region of Focus\n...\nplt.imshow(normed_array, extent=extent_84320700)\nplt.show()\n```\n\n## Roadmap\nI'll next be working on a more advance and statistically comprehensive feature like MaxEnt and its related target group background.\nThe aesthetic part of the map (i.e, visualisation) is also part of the roadmap.\nThis project is also following the guidelines and suggestions in Soley-Guardia et al.'s (2024) publication on the top ten hazards that were seen when modelling species distribution.\n\n## Contributing\nContributions are welcome. Feel free to open an issue for any suggestion or submit a pull request.\n\n## License\nThis project is licensed under the conventional MIT License - see the LICENSE file for details.\n\n## Acknowledgement\nThis eco-modelling package was inspired by Timoth\u00e9e Poisot's \"BioClim from scratch\" tutorial. Special thanks to Professor Poisot (@tpoisot) for creating such an informative guide on modelling the bioclimatic distribution of species.\n\n## References\n1. Mateo, R.G., Croat, T.B., Felic\u00edsimo, A.M. & Mu\u00f1oz, J. (2010) Profile or group discriminative techniques? Generating reliable species distribution models using pseudo-absences and target-group absences from natural history collections._Diversity and Distribution_, 16(1), 84-94. https://doi.org/10.1111/j.1472-4642.2009.00617.x\n2. Poisot, T. (2021) Building the BioClim model from scratch_.[\\[video\\]]YouTube.(https://www.youtube.com/watch?v=81MblyNWz3Q)\n3. Soley-Guardia, M., Alvarado-Serrano, D.F. & Anderson, R.P. (2024) _Top ten hazards to avoid when modeling species distributions: a didactic guide of assumptions, problems, and recommendations._Ecography_, e06852. https://doi.org/10.1111/ecog.06852",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple species distribution modelling package. Functionality is currently limited to BIOCLIM.",
    "version": "0.1.5",
    "project_urls": {
        "Documentation": "https://flit.pypa.io",
        "Source": "https://github.com/WenKang-Lee/EcoMod"
    },
    "split_keywords": [
        "species distribution",
        "ecological niche",
        "habitat suitability"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "83bace074aeaf06d0bb2cd119daff0032278734a26ffe8e9b8aa2b8fc8810f6f",
                "md5": "a3fa246562716935258844d61c734132",
                "sha256": "fc5d1a1a7f79ad0d8b73e3dbe4ca277a3d8d9da9d9657aa3afc1c6e72d8cc9b9"
            },
            "downloads": -1,
            "filename": "ecomod-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a3fa246562716935258844d61c734132",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 7655,
            "upload_time": "2024-03-10T03:11:27",
            "upload_time_iso_8601": "2024-03-10T03:11:27.550528Z",
            "url": "https://files.pythonhosted.org/packages/83/ba/ce074aeaf06d0bb2cd119daff0032278734a26ffe8e9b8aa2b8fc8810f6f/ecomod-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4ca04dbcafd0a704a1d99d27512d7a7a66e095a5b7e579f330e105c11099536a",
                "md5": "b98a5a7d7b6501e868aba1d961505885",
                "sha256": "3fc8d0308568d25d57947ca39710aa7ed4717b55383be180fba04d99db5a8ec2"
            },
            "downloads": -1,
            "filename": "ecomod-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "b98a5a7d7b6501e868aba1d961505885",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 25439721,
            "upload_time": "2024-03-10T03:11:39",
            "upload_time_iso_8601": "2024-03-10T03:11:39.676779Z",
            "url": "https://files.pythonhosted.org/packages/4c/a0/4dbcafd0a704a1d99d27512d7a7a66e095a5b7e579f330e105c11099536a/ecomod-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-10 03:11:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "WenKang-Lee",
    "github_project": "EcoMod",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "ecomod"
}
        
Elapsed time: 0.19821s