{"id":13949196,"url":"https://github.com/capstone-coal/pycoal","last_synced_at":"2025-10-21T19:42:34.349Z","repository":{"id":48231669,"uuid":"69925933","full_name":"capstone-coal/pycoal","owner":"capstone-coal","description":"Python toolkit for characterizing Coal and Open-pit surface mining impacts on American Lands","archived":false,"fork":false,"pushed_at":"2021-08-04T11:58:50.000Z","size":187357,"stargazers_count":29,"open_issues_count":10,"forks_count":13,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-07-07T01:04:45.132Z","etag":null,"topics":["classification","classification-algorithm","coal","hyperspectral-image-classification","open-surface-mining","python","surface-mining-activities"],"latest_commit_sha":null,"homepage":"http://capstone-coal.github.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/capstone-coal.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-04T01:41:49.000Z","updated_at":"2025-03-31T22:58:01.000Z","dependencies_parsed_at":"2022-09-14T08:40:32.663Z","dependency_job_id":null,"html_url":"https://github.com/capstone-coal/pycoal","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/capstone-coal/pycoal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capstone-coal%2Fpycoal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capstone-coal%2Fpycoal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capstone-coal%2Fpycoal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capstone-coal%2Fpycoal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capstone-coal","download_url":"https://codeload.github.com/capstone-coal/pycoal/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capstone-coal%2Fpycoal/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264719232,"owners_count":23653540,"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":["classification","classification-algorithm","coal","hyperspectral-image-classification","open-surface-mining","python","surface-mining-activities"],"created_at":"2024-08-08T05:01:40.406Z","updated_at":"2025-10-21T19:42:29.318Z","avatar_url":"https://github.com/capstone-coal.png","language":"Python","funding_links":[],"categories":["Natural Resources"],"sub_categories":["Soil and Land"],"readme":"======\nPycoal\n======\n\n**Development**\n\n|license| |PyPI| |Python3| |GoogleGroup| |documentation| |Travis| |Coveralls| |Requirements Status| |Anaconda-Server Version| |Anaconda-Server Downloads|\n\n**Docker**\n\n|Docker Pulls| |microbadger|\n\nCOAL is a Python library for processing hyperspectral imagery from remote sensing devices such as the\n`Airborne Visible/InfraRed Imaging Spectrometer (AVIRIS) \u003chttps://aviris.jpl.nasa.gov/\u003e`__ and \n`AVIRIS-Next Generation \u003chttps://avirisng.jpl.nasa.gov/\u003e`__ enabling scientific analysis of Coal and \nOpen-pit surface mining impacts on American Lands.\n\nIntroduction and Context\n------------------------\nMountain-top Mining (MTM) is a method of open surface mining with the primary aim of exploring and \nexploiting coal seams present within the land and solid earth (LSE) on mountaintops. Amongst other \nsurface mining activities, MTM is known to be an extremely destructive mining procedure predominantly \nlimited to the spatial boundaries of the Southern Appalachians (Eastern Kentucky, West Virginia \nand very small sections of Virginia and Tennessee). MTM is known to have caused irreparable damage \nto mountain landscapes and significant immediate and longer-term damage to key streams and watersheds. \nLarger afield, the rest of the U.S.A has some extensive surface mining in various places for \nexploitation of resources such as gravel/sand, various metals, other minerals and even radioactive \nmaterials, etc. Several studies have provided important scientific understanding related to the \nlocal, regional and state-level impacts of such environmentally destructive practices, however \na similar understanding on the national and continental levels are very much lacking.\n\nProject Motivation \u0026 Statement \n------------------------------\nCOAL provides a suite of algorithms (written in Python) to identify, classify, characterize,\nand quantify (by reporting a number of key metrics) the direct and indirect impacts of \nMTM and related destructive surface mining activities across the continental U.S.A (and further afield). \n\nMore information on COAL can be seen at the `Project Website \u003chttps://capstone-coal.github.io/\u003e`__ \nas well as the **docs** directory.\n\nInstallation\n------------\n\npip\n^^^\n|PyPI|\n\nThe Python COAL package **pycoal** can be installed from the cheeseshop\n\n::\n\n\tpip3 install pycoal\n    \nconda\n^^^^^\n|Anaconda-Server Version| |Anaconda-Server Downloads|\n\nor from conda\n\n::\n\n\tconda install -c conda-forge pycoal\n\nSource\n^^^^^^\n\nor from source\n\n::\n\n\tgit clone https://github.com/capstone-coal/pycoal.git \u0026\u0026 cd pycoal\n\tpython3 setup.py install\n\nDocker\n^^^^^^\n|Docker Pulls| |microbadger|\n\n`Docker \u003chttps://www.docker.com/\u003e`_ greatly simplifies installation of pycoal and the environment. \nThe image can be installed from `Dockerhub \u003chttps://hub.docker.com/\u003e`_ as follows\n\n::\n\n\tdocker pull capstonecoal/coal:latest\n\nAdditionally, if you are developing the image and wish to build it locally, you can run the following\n\n**Installation**\n\n1. Install `Docker \u003chttps://www.docker.com/\u003e`_.\n\n2. Build from files in this directory:\n\n::\n\n\tdocker build -t capstonecoal/coal .\n\n**Usage**\n\nStart up an image and attach to it\n\n::\n\n\tdocker run -t -i -d --name coalcontainer capstonecoal/coal /bin/bash\n\tdocker attach --sig-proxy=false coalcontainer\n\npycoal is located in /coal and is almost ready to run. You just need to grab some data.\n\nTests\n-----\n\n|Travis| |Coveralls|\n\nCOAL uses the popular `nose \u003chttp://nose.readthedocs.org/en/latest/\u003e`__\ntesting suite for unit tests.\n\nYou can run the COAL tests simply by running\n\n::\n\n    nosetests\n\nAdditonally, click on the build sticker at the top of this readme to be\ndirected to the most recent build on `travis-ci \u003chttps://travis-ci.org/capstone-coal/pycoal\u003e`__.\n\nQuickstart\n----------\n\nSee the `quickstart documentation \u003chttps://capstone-coal.github.io/docs#usage\u003e`_.\n\nIf you would like to run the examples yourself, head over to the **examples** module.\n\n**WARNING** Running the examples requires `additional downloads \u003chttps://github.com/capstone-coal/pycoal/tree/master/examples#aviris-ng-data\u003e`_. Ensure you have sufficient storage (~20 GB).\n\nDocumentation\n-------------\n\n|documentation|\n\nCOAL documentation can be found at `Readthedocs \u003chttp://pycoal.readthedocs.io\u003e`__ however you can also build documentation manually.\n\n::\n\n\t$ cd docs/source \u0026\u0026 make html\n\nDocumentation can then be located in **_build/html/index.html**\n\nCommunity and Development\n-------------------------\n\nSlack\n^^^^^^^^^^^^\n\n|Slack|\n\nQuestions, concerns, and general communication is all encouraged in our `Slack organization \u003chttps://capstone-coal.slack.com\u003e`_.\n\nMailing list\n^^^^^^^^^^^^\n\n|GoogleGroup|\n\nTo become involved or if you require help using the project request to join our mailing list.\n\nIssue Tracker\n^^^^^^^^^^^^^\n\nIf you have issue using COAL, please log a ticket in our `Github issue tracker \u003chttps://github.com/capstone-coal/coal/issues\u003e`__.\n\nLicense\n-------\n\nCOAL is licensed under the |license| a copy of which ships with this source code.\n\n.. |license| image:: https://anaconda.org/conda-forge/pycoal/badges/license.svg\n   :target: https://www.gnu.org/licenses/gpl-2.0.html\n.. |Python3| image:: https://img.shields.io/badge/python-3-blue.svg\n   :target: https://www.python.org/downloads/\n.. |PyPI| image:: https://img.shields.io/pypi/v/pycoal.svg?maxAge=2592000?style=plastic\n   :target: https://pypi.python.org/pypi/pycoal\n.. |Slack| image:: https://assets.brandfolder.com/pl546j-7le8zk-6gwiyo/element.png?v=1547165361\n    :target: https://capstone-coal.slack.com\n.. |GoogleGroup| image:: https://img.shields.io/badge/-Google%20Group-lightgrey.svg\n   :target: https://groups.google.com/forum/#!forum/coal-capstone\n.. |documentation| image:: https://readthedocs.org/projects/pycoal/badge/?version=latest\n   :target: http://pycoal.readthedocs.org/en/latest/\n.. |Travis| image:: https://img.shields.io/travis/capstone-coal/pycoal.svg?maxAge=2592000?style=plastic\n   :target: https://travis-ci.org/capstone-coal/pycoal\n.. |Coveralls| image:: https://coveralls.io/repos/github/capstone-coal/pycoal/badge.svg?branch=master\n   :target: https://coveralls.io/github/capstone-coal/pycoal?branch=master\n.. |Requirements Status| image:: https://requires.io/github/capstone-coal/pycoal/requirements.svg?branch=master\n   :target: https://requires.io/github/capstone-coal/pycoal/requirements/?branch=master\n.. |Anaconda-Server Version| image:: https://anaconda.org/conda-forge/pycoal/badges/version.svg\n   :target: https://anaconda.org/conda-forge/pycoal\n.. |Anaconda-Server Downloads| image:: https://anaconda.org/conda-forge/pycoal/badges/downloads.svg\n   :target: https://anaconda.org/conda-forge/pycoal\n.. |Docker Pulls| image:: https://img.shields.io/docker/pulls/capstonecoal/coal.svg?maxAge=2592000?style=plastic\n   :target: https://cloud.docker.com/swarm/capstonecoal/repository/docker/capstonecoal/coal/general\n.. |microbadger| image:: https://images.microbadger.com/badges/image/capstonecoal/coal.svg\n   :target: https://microbadger.com/images/capstonecoal/coal\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapstone-coal%2Fpycoal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapstone-coal%2Fpycoal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapstone-coal%2Fpycoal/lists"}