Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove linting GHA workflow #97

Merged
merged 2 commits into from
Dec 28, 2021
Merged

Remove linting GHA workflow #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d48b99
Remove linting workflow
andersy005 Dec 28, 2021
8306b49
Update README
andersy005 Dec 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions .github/workflows/linting.yaml
View file
Open in desktop

This file was deleted.

43 changes: 11 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# ecgtools

- [ecgtools](#ecgtools)
- [Badges](#badges)
| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![Code Coverage Status][codecov-badge]][codecov-link] |
| :---------- | :-----------------------------------------------------------------------------------------------------------------: |
| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |
| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |
| **License** | [![License][license-badge]][repo-link] |

## Badges
## Motivation

The critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using.

| CI | [![GitHub Workflow Status][github-ci-badge]][github-ci-link] [![GitHub Workflow Status][github-lint-badge]][github-lint-link] [![Code Coverage Status][codecov-badge]][codecov-link] |
| :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **Docs** | [![Documentation Status][rtd-badge]][rtd-link] |
| **Package** | [![Conda][conda-badge]][conda-link] [![PyPI][pypi-badge]][pypi-link] |
| **License** | [![License][license-badge]][repo-link] |
See [documentation](https://ecgtools.readthedocs.io) for more information.

<!-- ## Installation (COMING SOON)
## Installation

ecgtools can be installed from PyPI with pip:

```bash
python -m pip install ecgtools
```

ecgtools is also available from conda-forge for conda installations:
It is also available from conda-forge for conda installations:

```bash
conda install -c conda-forge ecgtools
```

See [documentation](https://ecgtools.readthedocs.io) for more information. -->

[github-ci-badge]: https://img.shields.io/github/workflow/status/NCAR/ecgtools/CI?label=CI&logo=github&style=for-the-badge
[github-lint-badge]: https://img.shields.io/github/workflow/status/NCAR/ecgtools/linting?label=linting&logo=github&style=for-the-badge
[github-ci-link]: https://github.com/NCAR/ecgtools/actions?query=workflow%3ACI
[github-lint-link]: https://github.com/NCAR/ecgtools/actions?query=workflow%3Alinting
[codecov-badge]: https://img.shields.io/codecov/c/github/NCAR/ecgtools.svg?logo=codecov&style=for-the-badge
[codecov-link]: https://codecov.io/gh/NCAR/ecgtools
[rtd-badge]: https://img.shields.io/readthedocs/ecgtools/latest.svg?style=for-the-badge
Expand All @@ -41,21 +38,3 @@ See [documentation](https://ecgtools.readthedocs.io) for more information. -->
[conda-link]: https://anaconda.org/conda-forge/ecgtools
[license-badge]: https://img.shields.io/github/license/NCAR/ecgtools?style=for-the-badge
[repo-link]: https://github.com/NCAR/ecgtools

## Motivation

Similar to [`intake-esm`](https://github.com/intake/intake-esm), this package helps with finding, investigating, and loading data. The critical requirement for using [`intake-esm`](https://github.com/intake/intake-esm) is having a data catalog. This package enables you build data catalogs to be read in by [`intake-esm`](https://github.com/intake/intake-esm), which enables a user to easily search, discover, and access datasets they are interested in using.

## Installation

ecgtools can be installed from PyPI with pip:

```bash
python -m pip install ecgtools
```

It is also available from conda-forge for conda installations:

```bash
conda install -c conda-forge ecgtools
```