Skip to content

Commit

Permalink
add conda badge
Browse files Browse the repository at this point in the history
  • Loading branch information
scottprahl committed Aug 27, 2023
1 parent 5d294c1 commit 20c048f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Changelog
=========

2.6.0 (unreleased)
--------------------
* add version and year to CITATION.cff
* remove 'v' from version numbers
* add github script and workflow to auto-update CITATION.cff

v2.5.3 (8/5/2023)
-------------------
* conda-forge fails because test files are not included
Expand Down
17 changes: 12 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ by Scott Prahl
.. image:: https://img.shields.io/pypi/v/miepython.svg
:target: https://pypi.org/project/miepython/

.. image:: https://img.shields.io/conda/v/conda-forge/miepython.svg
:target: https://anaconda.org/conda-forge/miepython

.. image:: https://img.shields.io/badge/readthedocs-latest-blue.svg
:target: https://miepython.readthedocs.io

Expand Down Expand Up @@ -44,10 +47,14 @@ When comparing different Mie scattering codes, make sure that you're aware of th
Using miepython
---------------

1. You can install locally using pip::
1. You can install using pip::

pip install miepython

or using conda::

conda install -c conda-forge miepython

2. or `run this code in the cloud using Google Collaboratory <https://colab.research.google.com/github/scottprahl/miepython/blob/master>`_ by selecting the Jupyter notebook that interests you.

An example
Expand All @@ -73,14 +80,14 @@ should produce::
The backscatter efficiency is 0.573
The scattering anisotropy is 0.192

Here are a few short scripts in the github repository.
There are a few short scripts in the github repository.

* `Extinction Efficiency of Absorbing and Non-Absorbing Spheres <https://github.com/scottprahl/miepython/blob/master/miepython/examples/01_dielectric.py>`_
* `Four Micron Glass Spheres <https://github.com/scottprahl/miepython/blob/master/miepython/examples/02_glass.py>`_

* `One Micron Water Droplets <https://github.com/scottprahl/miepython/blob/master/miepython/examples/03_droplets.py>`_
* `Gold Nanospheres <https://github.com/scottprahl/miepython/blob/master/miepython/examples/04_gold.py>`_

Detailed documentation is available at <https://miepython.readthedocs.io>
* `Gold Nanospheres <https://github.com/scottprahl/miepython/blob/master/miepython/examples/04_gold.py>`_


License
Expand Down

0 comments on commit 20c048f

Please sign in to comment.