├── README.md ├── CITATION.rst ├── maintenance └── data_upload_instructions.md ├── CONTRIBUTING.rst ├── CODE_OF_CONDUCT.md ├── LICENSE └── governance.md /README.md: -------------------------------------------------------------------------------- 1 | # SimPEG community 2 | 3 | This repository containts documents on governance, code of conduct, and contributor guides for SimPEG 4 | -------------------------------------------------------------------------------- /CITATION.rst: -------------------------------------------------------------------------------- 1 | Citing SimPEG 2 | ------------- 3 | 4 | There is a `paper about SimPEG `_, if you use this code, please help our scientific visibility by citing our work! 5 | 6 | 7 | Cockett, R., Kang, S., Heagy, L. J., Pidlisecky, A., & Oldenburg, D. W. (2015). SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications. Computers & Geosciences. 8 | 9 | 10 | BibTex: 11 | 12 | .. code:: 13 | 14 | @article{cockett2015simpeg, 15 | title={SimPEG: An open source framework for simulation and gradient based parameter estimation in geophysical applications}, 16 | author={Cockett, Rowan and Kang, Seogi and Heagy, Lindsey J and Pidlisecky, Adam and Oldenburg, Douglas W}, 17 | journal={Computers \& Geosciences}, 18 | year={2015}, 19 | publisher={Elsevier} 20 | } 21 | 22 | -------------------------------------------------------------------------------- /maintenance/data_upload_instructions.md: -------------------------------------------------------------------------------- 1 | # Upload Tutorial Data for SimPEG 2 | 3 | If you have permission to access the cloud storage repository, 4 | uploading data and linking to tutorials in documentation is done as follows: 5 | 6 | 1. **Access the google cloud** using the following URL https://console.cloud.google.com/ . If you have access, you should be taken to a Google Cloud Platform landing page. 7 | 8 | 2. **Finding storage bucket:** In the *Resources* panel, selected *Storage* 9 | --> From the list of storage locations, select the *simpeg* storage bucket 10 | --> Within this bucket, go to the *doc-assets* directory 11 | 12 | 3. **Uploading files:** Drag and drop the file into this directory. We expect that for the most part files are compressed to *tar.gz* 13 | 14 | 4. **Setting permissions:** For the file you have just uploaded, open the *object overflow menu*. This is the 'three dots' on the right side of the screen for the file. 15 | --> Go to *Edit permissions* 16 | --> Click *Add entry* and set *Entity* = Public, *Name* = allUsers and *Access* = Reader for the new entity 17 | --> Click *SAVE* 18 | 19 | 5. **URL for download link:** Click *COPY URL* to copy the downloable link to clipboard. 20 | -------------------------------------------------------------------------------- /CONTRIBUTING.rst: -------------------------------------------------------------------------------- 1 | .. _contributing: 2 | 3 | Contributing to SimPEG 4 | ======================= 5 | 6 | First of all, we are glad you are here! We welcome contributions and input 7 | from the community. 8 | 9 | This document is a set of guidelines for contributing to the repositories 10 | hosted in the `SimPEG `_ organization on GitHub. 11 | These repositories are maintained on a volunteer basis. 12 | 13 | 14 | .. _questions: 15 | 16 | Questions 17 | --------- 18 | 19 | Please do not create an issue to ask a question. You will get a faster 20 | response by posting on our Discourse discussion forum: 21 | https://simpeg.discourse.group/. If you prefer real-time chat, 22 | you can join our Mattermost Team at 23 | https://mattermost.softwareunderground.org/simpeg. 24 | 25 | .. _bugs: 26 | 27 | 28 | Bugs 29 | ---- 30 | 31 | When reporting an issue, please be as descriptive and provide sufficient 32 | detail to reproduce the error. Whenever possible, if you can include a small 33 | example that produces the error, this will help us resolve issues faster. 34 | 35 | 36 | .. _suggesting_enhancements: 37 | 38 | Suggesting enhancements 39 | ----------------------- 40 | 41 | We welcome ideas for improvements on SimPEG! When writing an issue to suggest 42 | an improvement, please 43 | 44 | - use a descriptive title, 45 | - explain where the gap in current functionality is, 46 | - include a pseudocode sketch of the intended functionality 47 | 48 | We will use the issue as a place to discuss and provide feedback. Please 49 | remember that SimPEG is maintained on a volunteer basis. If you suggest an 50 | enhancement, we certainly appreciate if you are also willing to take action 51 | and start a pull request! 52 | 53 | 54 | .. _contributing_new_code: 55 | 56 | Contributing new code 57 | --------------------- 58 | 59 | If you have an idea for how to improve SimPEG, please first create an issue 60 | and :ref:`suggest an enhancement `. We will use the 61 | issue as a place to discuss and make decisions on the suggestion. Once you are 62 | ready to take action and commit some code to SimPEG, please check out 63 | :ref:`Getting Started for Developers ` for 64 | tips on setting up a development environment and :ref:`Practices ` 65 | for a description of the development practices we aim to follow. In particular, 66 | 67 | - :ref:`testing ` 68 | - :ref:`documentation ` 69 | - :ref:`code style