Overview¶
Welcome! This is the main guide for contributing to Project Pythia. Project Pythia is an open community, and all contributions are welcome following our Code of Conduct. All of the content for Project Pythia is hosted on GitHub in a number of different public repositories. From this document you can learn about the many ways that you can contribute to this community project, and where you can find additional information. In many cases pertinent details may be found in repository-specific guides that should always be consulted in addition to this guide.
Ways to contribute¶
Starting a conversation¶
One of the easiest ways to contribute is to communicate with the Project Pythia community. You might, for example, suggest changes to content on the site, ask a clarifying question, or even respond to another community member’s question. There are a number of ways to have a dialogue with the Pythia community, such as by opening a GitHub issue, but the easiest method is to simply create (or respond to) a post on our discussion forum.
Add content to the Resource Gallery¶
The Project Pythia Resource Gallery contains a collection of links to useful resources that were created and are hosted outside of Project Pythia. Some examples include: documentation and tutorials for iconic packages such as Matplotlib, Cartopy, and Xarray; on-line courses from universities and other educational institutions; and Jupyter Notebook galleries assembled and maintained by a variety of other sites. We encourage the community to consider submitting your own geoscience education material links to Project Pythia.
Contributing a new link is easy with these three simple steps:
Navigate your web browser to the Issues tab of the Project Pythia portal repository.
Click on the button that says “New issue”.
Click on the row labeled “Update resource gallery”, and follow the instructions presented.
Your request will be reviewed, and you will be notified once your content has been accepted or if changes are requested.
Add to or update Pythia Foundations¶
Pythia Foundations is a collection of material that the Pythia team believes is essential knowledge for geoscientists to effectively use the Scientific Python Ecosystem. The Pythia Foundations content is hosted on a separate GitHub repository, and contributors should consult the Contributing to Foundations guide there for information specific to Foundations. However, adding or changing Foundations content requires contributors to be familiar with a few technologies and workflows, particularly conda and Git. Foundations has tutorials on both conda and Git/GitHub, including a section on how to specifically contribute to Project Pythia via GitHub.
Add a new Cookbook to Cookbooks Gallery¶
The Pythia Cookbook Gallery is a collection of “cookbooks” that describe workflows that solve a specific problem. Typically, a cookbook references material presented elsewhere in Project Pythia, such as Pythia Foundations. Each Cookbook is hosted in a separate GitHub repository under the umbrella Project Pythia organization. Contributors should consult the Contributing a New Cookbook guide. Like with contributing to Foundations, you will want to be familiar with conda and Git.
Update the Project Pythia portal¶
The Project Pythia portal is the homepage of Project Pythia
and the website you are currently on. It is not necessarily expected that external
contributors will want to make contributions directly to the portal
GitHub repository that
builds this website. Nevertheless, detailed information on how to contribute can be found in the CONTRIBUTING.md file located in the root directory of the portal
GitHub repository.