-
Notifications
You must be signed in to change notification settings - Fork 6
Organisational README #199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
trexfeathers
wants to merge
29
commits into
SciTools:main
Choose a base branch
from
trexfeathers:readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
5b55729
First go at organizational README.
trexfeathers 48f7bd9
Create privacy_policy.md
trexfeathers 04305ee
Update privacy_policy.md
trexfeathers 58def04
Create accessibility_statement.md
trexfeathers 41e4f9d
Update README.md
trexfeathers fc8af80
Finalise accessibility links.
trexfeathers a0725dd
First attempt at a Privacy Policy.
trexfeathers eec972d
Delete profile/accessibility_statement.md.
trexfeathers 69f2c54
Add email address.
trexfeathers 47fe2d8
Add contents
trexfeathers ff74cc3
Make it clearer that reading Accessible Icon is not required.
trexfeathers afc4f38
Some accessibility improvements.
trexfeathers 0b0d9b1
Correct comment format.
trexfeathers 51fe2a7
More accessible colours,
trexfeathers 234351c
Lettered list.
trexfeathers 1785469
More accessible titles.
trexfeathers 6d8be26
No more badges.
trexfeathers cf44552
Screen reader compatibility.
trexfeathers e1181bb
Better separators.
trexfeathers a3ae466
Table header.
trexfeathers 01877be
Clearer links.
trexfeathers a3adb72
Clearer links.
trexfeathers df5cff3
Jargon busting.
trexfeathers 45bd15c
Create accessibility_statement.md
trexfeathers 2f577fd
Completed accessibility statement.
trexfeathers 3c0b3d5
Link to accessibility statement.
trexfeathers 800d1aa
Increased compliance.
trexfeathers d199341
Updated Privacy Policy, mostly deferring to the originals.
trexfeathers 6fb852d
Updated Cartopy links to RTD.
trexfeathers File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
**Links:** [Privacy Policy](privacy_policy.md) | ||
, | ||
[Accessibility Statement](accessibility_statement.md) | ||
|
||
# SciTools | ||
|
||
## Open tools for the analysis and visualisation of Earth science data | ||
|
||
SciTools is a collaborative effort to produce powerful Python-based open-source tools for Earth scientists. Initially started at the UK [Met Office](https://www.metoffice.gov.uk/) in 2010, SciTools has grown into a diverse community of partners and collaborators from around the world. SciTools is responsible for the maintenance of a number of key packages such as Iris and Cartopy, and continues to develop new and innovative tools for the Earth scientist's toolkit. | ||
|
||
## Contents | ||
|
||
- [List of SciTools packages](#packages-package) | ||
- [More about SciTools](#more-about-scitools-information_source) | ||
|
||
## Packages :package: | ||
|
||
### Cartopy | ||
|
||
<img src="https://raw.githubusercontent.com/SciTools/cartopy/main/docs/source/_static/cartopy.png" height="100" alt="cartopy logo"> | ||
|
||
Cartopy is a Python package designed for geospatial data processing in order to produce maps and other geospatial data analyses. | ||
|
||
Key features of cartopy are its object oriented projection definitions, and its ability to transform points, lines, vectors, polygons and images between those projections. | ||
|
||
You will find Cartopy especially useful for large area / small scale data, where Cartesian assumptions of spherical data traditionally break down. | ||
|
||
**Links:** [GitHub](https://github.com/SciTools/cartopy) | ||
, | ||
[Documentation](https://cartopy.readthedocs.io/stable/) | ||
, | ||
[Gallery](https://cartopy.readthedocs.io/stable/gallery/index.html) | ||
|
||
### Iris | ||
|
||
<img src="https://raw.githubusercontent.com/SciTools/iris/main/docs/src/_static/iris-logo.svg" height="100" alt="iris logo"> | ||
|
||
The Iris package implements a data model to create a data abstraction layer which isolates analysis and visualisation code from data format specifics. The data model we have chosen is the [CF (Climate & Forecast) Data Model](https://cfconventions.org/). The implementation of this model we have called an Iris Cube. | ||
|
||
Iris currently supports read/write access to a range of data formats, including (CF-)[NetCDF](https://github.com/Unidata/netcdf-c), [GRIB](https://confluence.ecmwf.int/display/CKB/What+are+GRIB+files+and+how+can+I+read+them), and [PP](https://artefacts.ceda.ac.uk/badc_datadocs/um/umdp_F3-UMDPF3.pdf); fundamental data manipulation operations, such as arithmetic, interpolation, and statistics; and a range of integrated plotting options. | ||
|
||
**Links:** [GitHub](https://github.com/SciTools/iris) | ||
, | ||
[Documentation](https://scitools-iris.readthedocs.io/en/stable/) | ||
, | ||
[Gallery](https://scitools-iris.readthedocs.io/en/stable/generated/gallery/index.html) | ||
|
||
### Other highlights | ||
|
||
| Package | Description & Links | | ||
| - | - | | ||
| **iris-esmf-regrid** | A collection of structured and unstructured ESMF regridding schemes for Iris.<br>**Links:** [GitHub](https://github.com/SciTools-incubator/iris-esmf-regrid) , [Documentation](https://iris-esmf-regrid.readthedocs.io/en/stable/) , ([ESMF](https://earthsystemmodeling.org/)) | | ||
| **cf-units** | Units of measure as required by the Climate and Forecast (CF) Metadata Conventions.<br>**Links:** [GitHub](https://github.com/SciTools/cf-units) , [Documentation](https://cf-units.readthedocs.io/en/stable/) | | ||
| **nc-time-axis** | Provides support for a cftime axis in Matplotlib.<br>**Links:** [GitHub](https://github.com/SciTools/nc-time-axis) , [Documentation](https://nc-time-axis.readthedocs.io/en/stable/) , ([cftime](https://github.com/Unidata/cftime)) , ([Matplotlib](https://matplotlib.org/)) | | ||
| **tephi** | Tephigram plotting in Python.<br>**Links:** [GitHub](https://github.com/SciTools/tephi) , [Documentation](http://tephi.readthedocs.org/) , ([tephigrams](https://en.wikipedia.org/wiki/Tephigram)) | | ||
| **python-stratify** | Vectorized interpolators for Nd atmospheric and oceanographic data.<br>**Links:** [GitHub](https://github.com/SciTools/python-stratify) | | ||
|
||
### See more | ||
|
||
- [Pinned repositories](https://github.com/SciTools#:~:text=Pinned) | ||
- [Full repository list](https://github.com/SciTools#org-profile-repositories) | ||
- [SciTools-incubator](https://github.com/SciTools-incubator) organization - experimental SciTools projects | ||
- [SciTools-classroom](https://github.com/SciTools-classroom) organization - explore the power of SciTools through our collection of dedicated learning material and presentations | ||
|
||
## More about SciTools :information_source: | ||
|
||
### Software Licensing :inbox_tray: | ||
|
||
The rules/agreements for **using** the software. All SciTools software is distributed under the terms of the [**BSD-3-Clause**](https://spdx.org/licenses/BSD-3-Clause.html) licence. | ||
|
||
### Contributor Licence Agreement (CLA) :pencil: | ||
|
||
The rules/agreements for **contributing** to the software. Contributions to any SciTools repository are subject to the [**SciTools Contributor Licence Agreement**](https://cla-assistant.io/SciTools/). | ||
|
||
### Development :pencil2: | ||
|
||
The Met Office remains the driving force behind SciTools and most of our packages; however, all the packages are fundamentally developed in the open. The direction of SciTools packages is decided by the community of developers; who are always eager for more people from different areas to contribute towards Iris, Cartopy and the wider SciTools ecosystem. All types of contribution are encouraged: | ||
|
||
<!--- The list below has slightly odd formatting around the emojis to help it behave better with screen readers (keeping the page more accessible). --> | ||
|
||
- 1 :speech_balloon: : Participating in conversations on existing repository [discussions](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/about-discussions) / [issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) / [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) | ||
- 2 :bell: : Starting new repository [discussions](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/about-discussions) / [issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) | ||
- 3 :bulb: : Proposing changes via repository [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) | ||
- 4 :pencil2: : Developing your own software that uses or augments SciTools software package(s) | ||
|
||
Every SciTools repository has a team of _maintainers_ - developers with GitHub permissions to make changes to the codebase (typically via approving and merging pull requests). Maintainers do their best to respond to discussions / issues / pull requests and generally keep the repositories healthy. [Many of the SciTools repositories are discussed by maintainers at regular Peloton meetings](https://github.com/orgs/SciTools/projects/13?pane=info). | ||
|
||
### Contact :telephone_receiver: | ||
|
||
Please raise a [discussion](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/about-discussions) / [issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) / [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) on the appropriate SciTools repository. If your contact is not linked to a specific repository then you can use the [SciTools/.github](https://github.com/SciTools/.github) repository. The conversation can also continue in private, feel free to request this. While we prefer talking on GitHub, you can also email scitools.pub@gmail.com if necessary. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Accessibility Statement | ||
|
||
## How GitHub maximises accessibility | ||
|
||
This content is hosted by GitHub, so many accessibility concerns (e.g. background colour, keyboard control, type-facing) are deferred to the developers of the GitHub website itself. Below are some links to GitHub's own accessibility pages: | ||
|
||
- [GitHub accessibility settings](https://docs.github.com/en/get-started/accessibility) | ||
- [GitHub accessibility statement](https://accessibility.github.com/) | ||
- [Accessibility Conformance Report for GitHub.com](https://accessibility.github.com/conformance/github-com/) | ||
|
||
## How SciTools developers maximise accessibility in our GitHub text | ||
|
||
'GitHub text': on GitHub our accessibility efforts are directed at text intended for rendering on GitHub - such as README files, issues, comments. GitHub also hosts other content that is not the subject of the statements here: | ||
|
||
- Software code - plain text not designed for any rendering; readability is largely determined by the designers of the software language. | ||
- Documentation code - plain text designed for rendering by a third party service (e.g. [Sphinx](https://github.com/sphinx-doc/sphinx)), and hosting elsewhere. Should include its own dedicated accessibility statement. | ||
|
||
For concerns within the control of SciTools developers - as opposed to the developers of GitHub - the following efforts have been made to maximise accessibility, in line with the [Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21): | ||
|
||
- Use of the simplest language possible for the topic, i.e. avoid 'flowery language'. | ||
- Explanations and/or links are provided for any obscure terminology. | ||
- Clear, descriptive headings, with no skipping of heading levels. | ||
- Bulleted lists and tables to provide clearer structure (as opposed to lists within paragraphs). | ||
- Tables of contents are provided for large bodies of text, to aid quick navigation. | ||
- Descriptive links (as opposed to links saying "click here", for example). | ||
- Punctuation and emojis are used with consideration for how a screen reader will interpet the text. | ||
- Images include alt-text. | ||
- Badges | ||
- E.g. [shields.io](https://shields.io/). | ||
- Are only used where dynamic content is needed. | ||
- Include alt-text. | ||
- Basic links instead use plain text wherever possible. | ||
|
||
## How to contact | ||
|
||
If you find anything that is not accessible, please get in touch. We will endeavour to provide you an accessible alternative and to fix the original issue. [See the Contact instructions in the README file](README.md#contact-telephone_receiver). | ||
|
||
<!--TODO: | ||
Review relevant files in all SciTools[-incubator/classroom] repos (e.g. README files) to see if anything falls below this standard. | ||
We are required to include: | ||
- which parts of the 'website' do not meet accessibility standards and why | ||
- a timeline to make content accessible | ||
--> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Privacy Policy | ||
|
||
Collaborative software development via GitHub involves sharing certain personal data. The types of this personal data may vary depending on how a person interacts with the repositories, but typically include the below: | ||
|
||
- GitHub username, together with public profile information | ||
([GitHub: About your profile](https://docs.github.com/en/account-and-profile/concepts/about-your-profile)) | ||
- Name and email address, as recorded in commits | ||
- ([GitHub: Setting your username in Git](https://docs.github.com/en/get-started/git-basics/setting-your-username-in-git)) | ||
- ([GitHub: Setting your commit email address](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)) | ||
- Any other personal data a person chooses to share in text bodies that they write: | ||
- Code comments | ||
- Documentation | ||
- Git commit messages | ||
- GitHub issues, pull requests, discussions, etcetera. | ||
|
||
Personal data shared on the SciTools GitHub repositories is covered by the privacy policies listed below. | ||
|
||
## Met Office | ||
|
||
The Met Office will collect, use and process your personal data for the purposes of supporting the development of the SciTools Projects and recording ownership of contributions. Your personal data will be processed in accordance with the [Met Office Privacy Policy](https://www.metoffice.gov.uk/policies/privacy). The legal basis for processing is **contractual necessity**. | ||
|
||
## GitHub | ||
|
||
Your personal data will be stored on GitHub repositories and may therefore result in data leaving the UK / European Economic Area. For further information, please see the [GitHub General Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-general-privacy-statement). | ||
|
||
## CLA Assistant | ||
|
||
Your GitHub username will also be recorded on the CLA Assistant database. This data is stored on a Cosmos DB (MongoDB compatible) database hosted on Microsoft Azure in Europe. For further information, please see the [Microsoft Privacy Statement](https://privacy.microsoft.com/en-gb/privacystatement) and [CLA Assistant on GitHub](https://github.com/cla-assistant/cla-assistant). | ||
|
||
View the CLA here: [SciTools Contributor Licence Agreement](https://cla-assistant.io/SciTools/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry - forgot! Question for the reviewer: does this README capture the content of https://scitools.org.uk/? Albeit in a more abridged way relying on modern familiarity with GitHub and Open Source.