{"id":18818925,"url":"https://github.com/geoscienceaustralia/hazimp","last_synced_at":"2025-04-13T23:32:51.548Z","repository":{"id":5315977,"uuid":"6498395","full_name":"GeoscienceAustralia/hazimp","owner":"GeoscienceAustralia","description":"Hazard impact assessment tool","archived":false,"fork":false,"pushed_at":"2025-01-29T22:30:43.000Z","size":4810,"stargazers_count":14,"open_issues_count":4,"forks_count":7,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-03-27T13:45:51.838Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hazimp.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GeoscienceAustralia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.rst","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"authors.txt","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2012-11-01T23:04:20.000Z","updated_at":"2025-01-29T22:23:49.000Z","dependencies_parsed_at":"2023-01-11T16:59:44.758Z","dependency_job_id":"8c41f509-7d7f-4250-8fa1-65c5667b51c7","html_url":"https://github.com/GeoscienceAustralia/hazimp","commit_stats":{"total_commits":486,"total_committers":12,"mean_commits":40.5,"dds":"0.44650205761316875","last_synced_commit":"2e6cd7166bfc491489805ebe21323643116a58d6"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeoscienceAustralia%2Fhazimp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeoscienceAustralia%2Fhazimp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeoscienceAustralia%2Fhazimp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GeoscienceAustralia%2Fhazimp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GeoscienceAustralia","download_url":"https://codeload.github.com/GeoscienceAustralia/hazimp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248796949,"owners_count":21163056,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-08T00:19:29.017Z","updated_at":"2025-04-13T23:32:49.006Z","avatar_url":"https://github.com/GeoscienceAustralia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"HazImp\n======\n\nA natural hazard impact assessment tool.\n\nFor the latest documentation, installation guide and user guide, see https://hazimp.readthedocs.io\n[![Documentation Status](https://readthedocs.org/projects/hazimp/badge/?version=latest)](https://hazimp.readthedocs.io/en/latest/?badge=latest)\n\nThis branch enables users to develop new functions for HazImp.\n\nStatus\n------------\n\n[![Unit tests for HazImp (master branch)](https://github.com/GeoscienceAustralia/hazimp/actions/workflows/hazimp-tests.yml/badge.svg?branch=master)](https://github.com/GeoscienceAustralia/hazimp/actions/workflows/hazimp-tests.yml)\n[![Unit tests for HazImp (develop branch)](https://github.com/GeoscienceAustralia/hazimp/actions/workflows/hazimp-tests.yml/badge.svg?branch=develop)](https://github.com/GeoscienceAustralia/hazimp/actions/workflows/hazimp-tests.yml)\n[![Documentation Status](https://readthedocs.org/projects/hazimp/badge/?version=latest)](https://hazimp.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/GeoscienceAustralia/hazimp/branch/master/graph/badge.svg?token=YPcgBIMxts)](https://codecov.io/gh/GeoscienceAustralia/hazimp)\n\nData\n====\n\nAll exposure and hazard data under version control is for\ntesting purposes only and should not be considered as realistic.  The\nprovenance for this data is unknown.\n\nContributing code\n=================\n\nGenerally, development of new functionality and bug fixes happens in\nthe `develop` branch in HazImp.  The `master` branch is only for\nsignificant releases, and maintenance. Even then, any bug-fixes should\nfollow the procedure outlined below to contribute fixes - that is,\ncreate a new (temporary) branch, make the fix, then submit teh fix as\na pull request. Once the pull request has been approved and merged,\nthe temporary branch can be deleted.\n\nThe preferred way to contribute to HazImp is to fork the\n[main repository](http://github.com/GeoscienceAustralia/hazimp) on GitHub:\n\n1. Fork the [project repository](http://github.com/GeoscienceAustralia/hazimp):\n   click on the 'Fork' button near the top of the page. This creates\n   a copy of the code under your account on the GitHub server.\n\n2. Clone this copy to your local disk::\n          $ git clone git@github.com:YourLogin/hazimp.git\n          $ cd hazimp\n\n3. Create a branch to hold your changes::\n\n          $ git checkout -b my-feature\n\n   and start making changes. Never work in the ``master`` branch! We recommend\n   starting from the ``develop`` branch, where we do our development work.\n\n4. Check the code using the unit test suite. This will also run a quick check of\n   the code syntax using ``pycodestyle`` and produce a test coverage report\n   using ``coverage``::\n\n         $ pytest --cov\n\n   If this passes with no errors, then you can commit the changes.\n\n5. Work on this copy on your computer using Git to do the version\n   control. When you're done editing, do::\n\n          $ git add modified_files\n          $ git commit\n\n   to record your changes in Git, then push them to GitHub with::\n\n          $ git push -u origin my-feature\n\nFinally, go to the web page of your fork of the hazimp repo,\nand click 'Pull request' to send your changes to the maintainers for\nreview. request. This will send an email to the committers.\n\n(If any of the above seems like magic to you, then look up the\n[Git documentation](http://git-scm.com/documentation) on the web.)\n\nIt is recommended to check that your contribution complies with the\nfollowing rules before submitting a pull request:\n\n-  All public methods should have informative docstrings with sample\n   usage presented as doctests when appropriate.\n\n-  When adding additional functionality, provide at least one\n   example script in the ``examples/`` folder. Have a look at other\n   examples for reference. Examples should demonstrate why the new\n   functionality is useful in practice.\n\n-  At least one paragraph of narrative documentation with links to\n   references in the literature (with PDF links when possible) and\n   an example.\n\nYou can also check for common programming errors with the following\ntools:\n\n-  Code with good unittest coverage. This will also check syntax to\n ensure PEP8 conformance. Check with::\n\n          $ pip install pytest coverage --user\n          $ pytest\n\n-  No PEP8 warnings, check with::\n\n           $ pip install pep8\n           $ pep8 path/to/module.py\n\n-  AutoPEP8 can help you fix some of the easy redundant errors::\n\n           $ pip install autopep8\n           $ autopep8 path/to/pep8.py\n\nIssues\n------\n\nA great way to start contributing to HazImp is to pick an item\nfrom the list of [Issues](https://github.com/GeoscienceAustralia/hazimp/issues)\nin the issue tracker. (Well there are none there yet, but we will be\nputting some up soon!) Resolving these issues allow you to start\ncontributing to the project without much prior knowledge. Your\nassistance in this area will be greatly appreciated by the more\nexperienced developers as it helps free up their time to concentrate on\nother issues.\n\nDocumentation\n-------------\n\nWe are glad to accept any sort of documentation: function docstrings,\nreStructuredText documents (like this one), tutorials, etc.\nreStructuredText documents (will) live in the source code repository under the\ndocs/ directory.\n\nWhen writing documentation, it is important to keep a good\ncompromise between mathematical and algorithmic details, and give\nintuition to the reader on what the algorithm does. It is best to always\nstart with a small paragraph with a hand-waving explanation of what the\nmethod does to the data and a figure (coming from an example)\nillustrating it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoscienceaustralia%2Fhazimp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeoscienceaustralia%2Fhazimp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeoscienceaustralia%2Fhazimp/lists"}