emove FileFormats from repository and some minor cleanups

stonerlab · Jan 3, 2024 · 9d208a3 · 9d208a3
1 parent 5410b1e
commit 9d208a3
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 72 deletions.
diff --git a/README.rst b/README.rst
@@ -1,8 +1,8 @@
 .. image:: https://github.com/stonerlab/Stoner-PythonCode/actions/workflows/run-tests-action.yaml/badge.svg?branch=master
     :target: https://github.com/stonerlab/Stoner-PythonCode/actions/workflows/run-tests-action.yaml
 
-.. image:: https://coveralls.io/repos/github/stonerlab/Stoner-PythonCode/badge.svg?branch=master
-    :target: https://coveralls.io/github/stonerlab/Stoner-PythonCode?branch=master
+.. image:: https://app.codacy.com/project/badge/Coverage/a9069a1567114a22b25d63fd4c50b228
+    :target: https://app.codacy.com/gh/stonerlab/Stoner-PythonCode/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage
 
 .. image:: https://app.codacy.com/project/badge/Grade/a9069a1567114a22b25d63fd4c50b228
     :target: https://app.codacy.com/gh/stonerlab/Stoner-PythonCode/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

diff --git a/Stoner/FileFormats.py b/Stoner/FileFormats.py
diff --git a/doc/UserGuide/cookbook.rst b/doc/UserGuide/cookbook.rst
@@ -202,9 +202,8 @@ modelling codes, such OOMMF or MuMax. When modelling a 3D system, it is often us
 be able to examine a cross-section of the simulation. The Stoner package provides tools
 to quickly examine the output data::
 
-    from Stoner.FileFormats import OVFFile # reads OOMMF vector field files
-    import Stoner.plot
-    p=SP.PlotFile('my_simulation.ovf')
+    from Stoner import Data
+    p=Data('my_simulation.ovf')
     p.setas="xyzuvw"
     p=p.section(z=10.5) # Take a slice in the xy plane where z is 10.5 nm
     p.plot() # A 3D plot with cones

diff --git a/doc/UserGuide/datafolder.rst b/doc/UserGuide/datafolder.rst
@@ -46,8 +46,7 @@ then a new instance *f* is created. The optional *pattern* keyword is used to on
 the files with a .dat extension. In this example, it is assumed that the files are readable by
 the :py:class:`Stoner.Core.Data` general class, if they are in some other format then the 'type' keyword can be used::
 
-   from Stoner.FileFormats import XRDFile
-   f=DataFolder(type=XRDFile,pattern='*.dql')
+   f=DataFolder(type="XRDFile",pattern='*.dql')
 
 Strictly, the class pointed to be a the *type* keyword should be a sub class of :py:class:`Stoner.Core.metadataObject`
 and should have a constructor that undersatands the initial string parameter to be a filename to load the object from. The class

diff --git a/doc/readme.rst b/doc/readme.rst
@@ -1,8 +1,8 @@
 .. image:: https://github.com/stonerlab/Stoner-PythonCode/actions/workflows/run-tests-action.yaml/badge.svg?branch=master
     :target: https://github.com/stonerlab/Stoner-PythonCode/actions/workflows/run-tests-action.yaml
 
-.. image:: https://coveralls.io/repos/github/stonerlab/Stoner-PythonCode/badge.svg?branch=master
-    :target: https://coveralls.io/github/stonerlab/Stoner-PythonCode?branch=master
+.. image:: https://app.codacy.com/project/badge/Coverage/a9069a1567114a22b25d63fd4c50b228
+    :target: https://app.codacy.com/gh/stonerlab/Stoner-PythonCode/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage
 
 .. image:: https://app.codacy.com/project/badge/Grade/a9069a1567114a22b25d63fd4c50b228
     :target: https://app.codacy.com/gh/stonerlab/Stoner-PythonCode/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade