MAAP
Discover and use biomass relevant data, integrating the data for comparison, analysis, evaluation, and generation.
https://github.com/MAAP-Project/maap-documentation
Keywords from Contributors
stac
Last synced: over 1 year ago
JSON representation
Acceptance Criteria
- Revelant topics? false
- External users? true
- Open source license? false
- Active? true
- Fork? false
Repository metadata
- Host: GitHub
- URL: https://github.com/MAAP-Project/maap-documentation
- Owner: MAAP-Project
- Created: 2020-01-22T16:39:38.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-23T22:08:09.000Z (over 1 year ago)
- Last Synced: 2024-01-24T01:11:12.274Z (over 1 year ago)
- Size: 470 MB
- Stars: 9
- Watchers: 11
- Forks: 12
- Open Issues: 37
- Releases: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
README.md
maap-documentation
This repository serves as the technical documentation for interfacing with the MAAP services.
Contributing to MAAP Documentation
MAAP documentation is hosted on maap-project.readthedocs.io, is built using Sphinx and written in reStructuredText. If you want to contribute to the documentation, you can do so by forking the repository, creating a branch for your changes and editing the documentation files in the docs directory of the repo.
This should be built using Python >=3.11.
OS-version of Pandoc is also required.
You need to install Sphinx and supporting packages locally so you can ensure that your edits display correctly before making a pull request to the repository. These steps must be performed locally since MAAP's ADE does not support running a server and likely will not in the future.
To install supporting packages, run the following command:
pip install -r requirements.txt
After installing the necessary packages you build the docs using the following command from the docs directory:
cd docs
make html
Once the docs have been built successfully, there should be a build/ directory with the HTML pages.
To verify the pages look as expected run a local python server.
cd build/html
python3 -m http.server
# If you are not prompted open a web browser and go to http://localhost:8000/ (default)
Running Notebooks Locally
To run the documentation notebook code, you must make several configurations.
Install JupyterHub.
Install the maap-py library.
- Switch to your virtual environment that you wish to install in.
pip install matplotlib==3.3.1- Clone maap-py with
git clone [email protected]:MAAP-Project/maap-py.git cd maap-pythenpython setup.py install
Owner metadata
- Name: MAAP-Project
- Login: MAAP-Project
- Email:
- Kind: organization
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/42812645?v=4
- Repositories: 43
- Last ynced at: 2023-03-05T05:57:33.978Z
- Profile URL: https://github.com/MAAP-Project
Committers metadata
Last synced: over 1 year ago
Total Commits: 657
Total Committers: 21
Avg Commits per committer: 31.286
Development Distribution Score (DDS): 0.769
Commits in past year: 432
Committers in past year: 18
Avg Commits per committer in past year: 24.0
Development Distribution Score (DDS) in past year: 0.648
| Name | Commits | |
|---|---|---|
| smk0033 | s****3@u****u | 152 |
| Samuel Ayers | s****2@u****u | 107 |
| Rob Tapella | r****a@j****v | 68 |
| Aimee Barciauskas | a****e@d****g | 67 |
| grallewellyn | g****n@j****v | 50 |
| Sumant Jha | s****a@n****v | 37 |
| emileten | e****s@g****m | 29 |
| kmarkert | k****t@g****m | 29 |
| Alex | a****x@d****g | 21 |
| Emma Paz | e****a@d****g | 20 |
| Nikita Susan Joseph | 5****b | 16 |
| Jamison French | 5****h | 15 |
| anisbhsl | b****2@g****m | 13 |
| Marjorie Lucas | m****s@j****v | 11 |
| omshinde23 | r****e@u****u | 8 |
| bsatoriu | b****s@j****v | 5 |
| Sean Quinlan | 1****n | 3 |
| George Chang | g****g@j****v | 2 |
| “slesaad” | s****d@g****m | 2 |
| Phil Varner | p****r@g****m | 1 |
| Sujen Shah | s****2 | 1 |
Committer domains:
- jpl.nasa.gov: 5
- developmentseed.org: 3
- uah.edu: 3
- nasa.gov: 1
Issue and Pull Request metadata
Last synced: over 1 year ago
Total issues: 98
Total pull requests: 272
Average time to close issues: 2 months
Average time to close pull requests: 13 days
Total issue authors: 11
Total pull request authors: 21
Average comments per issue: 1.86
Average comments per pull request: 1.95
Merged pull request: 235
Bot issues: 0
Bot pull requests: 0
Past year issues: 84
Past year pull requests: 141
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 9 days
Past year issue authors: 6
Past year pull request authors: 17
Past year average comments per issue: 1.73
Past year average comments per pull request: 2.84
Past year merged pull request: 117
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- smk0033 (42)
- wildintellect (21)
- rtapella (17)
- emileten (5)
- abarciauskas-bgse (4)
- omshinde (4)
- anilnatha (1)
- jjfrench (1)
- marjo-luc (1)
- nmt28 (1)
- philvarner (1)
Top Pull Request Authors
- spa0002 (86)
- smk0033 (45)
- abarciauskas-bgse (25)
- jjfrench (19)
- wildintellect (18)
- rtapella (18)
- emileten (8)
- grallewellyn (8)
- marjo-luc (7)
- sumantjha (7)
- sdradsb (6)
- bsatoriu (5)
- KMarkert (4)
- omshinde (4)
- emmalu (3)
Top Issue Labels
- documentation (53)
- bug (24)
- enhancement (4)
Top Pull Request Labels
- documentation (40)
- bug (4)
- enhancement (1)
- help wanted (1)
Dependencies
- folium *
- h5py *
- ipykernel *
- nbconvert *
- nbsphinx *
- pandas *
- pandoc *
- pystac-client *
- sphinx >=1.4
- sphinx-rtd-theme *
- sphinxcontrib-napoleon *
Score: 6.873163834212518