diff --git a/README.rst b/README.rst
index a106976..e7f0881 100644
--- a/README.rst
+++ b/README.rst
@@ -8,8 +8,8 @@ bg-mpl-stylesheets
.. |Black| image:: https://img.shields.io/badge/code_style-black-black
:target: https://github.com/psf/black
-.. |Codecov| image:: https://codecov.io/gh/bg-mpl-stylesheets/bg-mpl-stylesheets/branch/main/graph/badge.svg
- :target: https://codecov.io/gh/bg-mpl-stylesheets/bg-mpl-stylesheets
+.. |Codecov| image:: https://codecov.io/gh/Billingegroup/bg-mpl-stylesheets/branch/main/graph/badge.svg
+ :target: https://codecov.io/gh/Billingegroup/bg-mpl-stylesheets
.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/bg-mpl-stylesheets
:target: https://anaconda.org/conda-forge/bg-mpl-stylesheets
@@ -23,7 +23,7 @@ bg-mpl-stylesheets
:target: https://pypi.org/project/bg-mpl-stylesheets/
.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
- :target: https://github.com/bg-mpl-stylesheets/bg-mpl-stylesheets/issues
+ :target: https://github.com/Billingegroup/bg-mpl-stylesheets/issues
A package for using Billinge group style files
@@ -34,7 +34,7 @@ Citation
If you use bg-mpl-stylesheets in a scientific publication, we would like you to cite this package as
- bg-mpl-stylesheets Package, https://github.com/bg-mpl-stylesheets/bg-mpl-stylesheets
+ bg-mpl-stylesheets Package, https://github.com/Billingegroup/bg-mpl-stylesheets
Installation
------------
@@ -69,7 +69,7 @@ and then install the package ::
pip install bg-mpl-stylesheets
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
-`GitHub `_. Once installed, ``cd`` into your ``bg-mpl-stylesheets`` directory
+`GitHub `_. Once installed, ``cd`` into your ``bg-mpl-stylesheets`` directory
and run the following ::
pip install .
@@ -132,7 +132,7 @@ You can also update style parameters locally by using the matplotlib style conte
plt.ylabel('some numbers')
plt.show()
-Here are a snapshot of values in ``all_styles["bg_style"]`` sheet which you may override with ``rc.parms`` to fine tune things: ::
+Here are a snapshot of values in ``all_styles["bg-style"]`` sheet which you may override with ``rc.parms`` to fine tune things: ::
'lines.linewidth': 2.50,
'lines.markeredgewidth': 0.25,
@@ -205,7 +205,7 @@ Support and Contribute
`Diffpy user group `_ is the discussion forum for general questions and discussions about the use of bg-mpl-stylesheets. Please join the bg-mpl-stylesheets users community by joining the Google group. The bg-mpl-stylesheets project welcomes your expertise and enthusiasm!
-If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_.
+If you see a bug or want to request a feature, please `report it as an issue `_ and/or `submit a fix as a PR `_. You can also post it to the `Diffpy user group `_.
Feel free to fork the project and contribute. To install bg-mpl-stylesheets
in a development mode, with its sources being directly used by Python
@@ -228,7 +228,9 @@ trying to commit again.
Improvements and fixes are always appreciated.
-Before contribuing, please read our `Code of Conduct `_.
+Before contribuing, please read our `Code of Conduct `_.
+
+
Contact
-------
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 112d170..a4a213c 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -17,13 +17,13 @@ bg-mpl-stylesheets is developed by Billinge Group
and its community contributors.
For a detailed list of contributors see
-https://github.com/bg-mpl-stylesheets/bg-mpl-stylesheets/graphs/contributors.
+https://github.com/Billingegroup/bg-mpl-stylesheets/graphs/contributors.
============
Installation
============
-See the `README `_
+See the `README `_
file included with the distribution.
=================
diff --git a/example/color_cycles.py b/example/color_cycles.py
index ac36cae..402f9ec 100644
--- a/example/color_cycles.py
+++ b/example/color_cycles.py
@@ -5,7 +5,7 @@
# please read the README about how to install the group plot style package
# and how to import it and use
-plt.style.use(all_styles["bg_style"])
+plt.style.use(all_styles["bg-style"])
x = np.arange(0, 1, 0.01)
diff --git a/example/plot.py b/example/plot.py
index fa2c52e..9464dea 100644
--- a/example/plot.py
+++ b/example/plot.py
@@ -5,7 +5,7 @@
# please read the README about how to install the group plot style package
# and how to import it and use
-plt.style.use(all_styles["bg_style"])
+plt.style.use(all_styles["bg-style"])
# load PDF data
r, gcalc, dr, dg, gdiff = loadData("example/CdSe_data.fgr").T
diff --git a/news/tutorial.rst b/news/tutorial.rst
new file mode 100644
index 0000000..6621d06
--- /dev/null
+++ b/news/tutorial.rst
@@ -0,0 +1,23 @@
+**Added:**
+
+*
+
+**Changed:**
+
+* key name in the style dictionary from all_styles["bg_style"] to all_styles["bg-style"]
+
+**Deprecated:**
+
+*
+
+**Removed:**
+
+*
+
+**Fixed:**
+
+* URLs referring to the organization in README.md
+
+**Security:**
+
+*
diff --git a/src/bg_mpl_stylesheets/styles.py b/src/bg_mpl_stylesheets/styles.py
index e561759..b9e809d 100644
--- a/src/bg_mpl_stylesheets/styles.py
+++ b/src/bg_mpl_stylesheets/styles.py
@@ -102,7 +102,7 @@ def update_style_with_latex(style):
return style
-all_styles = {"bg_style": bg_style}
+all_styles = {"bg-style": bg_style}
for key, style in all_styles.items():
all_styles.update({key: update_style_with_latex(style)})
diff --git a/src/bg_mpl_stylesheets/tests/test_bg_mpl_stylesheet.py b/src/bg_mpl_stylesheets/tests/test_bg_mpl_stylesheet.py
index f4980fb..fe5907f 100644
--- a/src/bg_mpl_stylesheets/tests/test_bg_mpl_stylesheet.py
+++ b/src/bg_mpl_stylesheets/tests/test_bg_mpl_stylesheet.py
@@ -4,7 +4,7 @@
def test_update_style_with_latex():
- actual = styles.update_style_with_latex(styles.all_styles["bg_style"])
+ actual = styles.update_style_with_latex(styles.all_styles["bg-style"])
expected = expected_style
assert expected == actual