Skip to content

Commit

Permalink
Merge pull request #137 from sandialabs/dev
Browse files Browse the repository at this point in the history
f conda until get source distro working
  • Loading branch information
mrbuche committed Jan 25, 2023
2 parents 3a93fb6 + 42dd91a commit f0e5825
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 109 deletions.
40 changes: 0 additions & 40 deletions .github/workflows/conda.yml

This file was deleted.

26 changes: 5 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,14 @@ The library is implemented entirely in Rust, including the Python API. The Julia
[![docs (stable)](https://img.shields.io/badge/Docs-stable-8CA1AF?logo=readthedocs)](https://polymers.readthedocs.io/en/stable)
[![docs (latest)](https://img.shields.io/badge/Docs-latest-8CA1AF?logo=readthedocs)](https://polymers.readthedocs.io/en/latest)
[![pypi](https://img.shields.io/pypi/v/polymers?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE)](https://pypi.org/project/polymers)
[![anaconda](https://img.shields.io/conda/v/mrbuche/polymers.svg?logo=anaconda&color=3EB049&label=Anaconda)](https://anaconda.org/mrbuche/polymers/)

The library can be installed as a Python package using
The library can be installed as a Python package:

```shell
pip install polymers
```

or as Python package within a Conda environment using

```shell
conda install --channel mrbuche polymers
```

If Rust is installed, the latest edition of the library can be installed from the main branch of the GitHub repository:
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:

```shell
git clone git@github.com:sandialabs/Polymers.git
Expand All @@ -39,37 +32,28 @@ pip install target/wheels/*.whl

[![docs (stable)](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/julia-docs-stable.svg)](https://sandialabs.github.io/Polymers/julia/docs/stable/polymers)
[![docs (latest)](https://raw.githubusercontent.com/sandialabs/Polymers/main/pages/assets/images/julia-docs-latest.svg)](https://sandialabs.github.io/Polymers/julia/docs/latest/polymers)
[![anaconda](https://img.shields.io/conda/v/mrbuche/polymers.svg?logo=anaconda&color=3EB049&label=Anaconda)](https://anaconda.org/mrbuche/polymers/)

The latest edition of the library can be installed as a Julia package using
The latest edition of the library can be installed as a Julia package:

```julia
using Pkg
Pkg.add(url="https://github.com/sandialabs/Polymers")
Pkg.build("Polymers")
```

or as Julia package within a Conda environment using

```shell
conda install --channel mrbuche polymers
```

## Rust

[![docs (stable)](https://img.shields.io/badge/Docs-stable-f46623?logo=rust&logoColor=000000)](https://docs.rs/crate/polymers)
[![docs (latest)](https://img.shields.io/badge/Docs-latest-f46623?logo=rust&logoColor=000000)](https://sandialabs.github.io/Polymers/rust/docs/latest/polymers)
[![crates](https://img.shields.io/crates/v/polymers?logo=rust&logoColor=000000&label=Crates&color=32592f)](https://crates.io/crates/polymers)

The library can be used in an existing Rust project by adding the `polymers` crate as a dependency in Cargo.toml:
The library can be used in an existing Rust project by adding the `polymers` crate to Cargo.toml:

```toml
[dependencies]
polymers = "*"
```
The asterisk `*` represents the newest released version of the crate, and should be changed to a specific version.

To use the latest edition of the library, add the main branch of the GitHub repository to Cargo.toml:
To use the latest edition of the library, add the GitHub repository to Cargo.toml:

```toml
[dependencies]
Expand Down
37 changes: 0 additions & 37 deletions conda/meta.yaml

This file was deleted.

13 changes: 2 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,15 @@ This is the documentation for Python API, which is implemented in Rust.
Installation
------------

|pypi| |conda|
|pypi|

The library can be installed as a Python package using

.. code-block:: sh
pip install polymers
or as Python package within a Conda environment using

.. code-block:: sh
conda install --channel mrbuche polymers
The latest edition of the library can be installed from the main branch of the GitHub repository:
If Rust is installed, the latest edition of the library can be installed from the GitHub repository:

.. code-block:: sh
Expand Down Expand Up @@ -55,9 +49,6 @@ Copyright 2022 National Technology & Engineering Solutions of Sandia, LLC (NTESS
.. |pypi| image:: https://img.shields.io/pypi/v/polymers?logo=pypi&logoColor=FBE072&label=PyPI&color=4B8BBE
:target: https://pypi.org/project/polymers

.. |conda| image:: https://img.shields.io/conda/v/mrbuche/polymers.svg?logo=anaconda&color=3EB049&label=Anaconda
:target: https://anaconda.org/mrbuche/polymers

.. |zenodo| image:: https://img.shields.io/badge/Zenodo-10.5281%2Fzenodo.7041983-blue
:target: https://doi.org/10.5281/zenodo.7041983

Expand Down

0 comments on commit f0e5825

Please sign in to comment.