Skip to content

Commit

Permalink
fix readme formatting for pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
FaustinCarter committed Nov 8, 2017
1 parent 1d1d0d0 commit 552f58c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
Version 0.3.1:

* Fix README formatting for PyPI

Version 0.3.0:

* Fixed a bug in the plotting routines that was drawing incorrect x-axis labels
Expand Down
16 changes: 6 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
scraps stands for: SuperConducting Resonator Analysis and Plotting Software
=============

.. |DOI| image:: https://zenodo.org/badge/23506/FaustinCarter/scraps.svg
:target: https://doi.org/10.1109/TASC.2016.2625767

===========================================================================
Scraps is a package designed to help you analyze lots of data from superconducting
resonators. The basic idea is that you hook up your VNA (or mixer) and measure S21
at several different temperatures and driving powers. Maybe you have a PID and some
Expand All @@ -19,12 +15,12 @@ also, as well as noise in addition to S21. If you would like to be a part of tha
get involved by posting a message here.

License
-----
-------
Scraps is licensed under the MIT license, so feel free to copy it, play with it,
modify it, etc. under those terms (which are pretty loose!).

Documentation
--------
-------------
Installation is as simple as::

pip install scraps
Expand All @@ -41,7 +37,7 @@ For complete API documentation, more in depth installation instructions and some
example tutorials, see the official documentation at: http://scraps.readthedocs.io

Citation
------
--------
If you use scraps to make plots or analyze data for a publication, please cite the IEEE Applied Superconductivity Manuscript, DOI: `10.1109/TASC.2016.2625767 <https://doi.org/10.1109/TASC.2016.2625767>`_::
@article{Carter2016,
Expand All @@ -58,7 +54,7 @@ If you use scraps to make plots or analyze data for a publication, please cite t
}

Short description of files that aren't code:
------------------
--------------------------------------------

- Example1: a JuPyter notebook that will help you get started with the basics.
Focus is on a single S21 sweep.
Expand All @@ -76,7 +72,7 @@ Short description of files that aren't code:
- readthedocs.yml and environment.yml: These are needed to properly build the documentation hosted at RTD.

Support
------
-------
Please post any bugs or feature requests here on GitHub. Bugs will be squashed ASAP.
Feature requests will be seriously considered!

Expand Down
2 changes: 1 addition & 1 deletion VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.3.0
0.3.1

0 comments on commit 552f58c

Please sign in to comment.