Make documentation and file changes

CHANGELOG.md

@@ -6,10 +6,22 @@ All notable changes will be made in this file.
 
 ### Added
 
+- (#18) Implemented Cocircuits and covectors.
+- (#14) Added some additional examples to ensure tests catch potential errors.
+
 ### Changed
 
+- (#22) Updated the documentation to be more complete.
+- (#12) Altered it so that the `to_xxx()` functions are encapsulated in the function `change_type()`.
+- (#2) Updated package to fit into up to date methods for making packages.
+- (#1) Restructed the OrientedMatroids class. In particular:
+    - Removed the category implementation and structured based off the matroid implementation.
+    - There is now an `AbstractOrientedMatroid` class which handles the abstract methods and everything pulls from here.
+
 ### Fixed
 
+- (#15) Fixed the groundset error bug.
+
 
 ## [0.0.2] - 2020-12-15
 

README.md

@@ -4,9 +4,10 @@ This package contains an oriented matroid implementation for sagemath.
 
 ## Current version
 
-**NOTE:** This package currently does not work. If you would like to help with the development, please let Aram know.
+The current version is 0.1.0 and is compatible with sagemath 10.0. It is in beta and is open for testing from others.
+
+**NOTE:** This package will be integrating into SageMath directly. If you see any errors while using this please, open an issue and let us know so we can correct it.
 
-The current version is 0.1.0 and is compatible with sagemath 10.0.
 
 ## Installation
 

docs/source/conf.py

@@ -47,7 +47,8 @@
 # ones.
 extensions = [
     #'sphinx.ext.autodoc',
-    'sage_autodoc',
+    #'sage_autodoc',
+    'sage_docbuild.ext.sage_autodoc',
     'sage_package.sphinx',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
@@ -232,7 +233,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', package_name + '.tex', u'Documentation of ' + unicode(package_name),
+  ('index', package_name + '.tex', u'Documentation of ' + str(package_name),
    authors, 'manual'),
 ]
 
@@ -262,7 +263,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', package_name, unicode(package_name) + u" documentation",
+    ('index', package_name, str(package_name) + u" documentation",
      [authors], 1)
 ]
 
@@ -276,7 +277,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', package_name, unicode(package_name) + u" documentation",
+  ('index', package_name, str(package_name) + u" documentation",
    authors, package_name, project,
    'Miscellaneous'),
 ]
@@ -322,7 +323,7 @@
     exclude_patterns=['**/'+os.path.join(mathjax_relative, i) for i in ('docs', 'README*', 'test',
                                                                         'unpacked', 'LICENSE')]
 else:
-     extensions.append('sphinx.ext.pngmath')
+     extensions.append('sphinx.ext.imgmath')
 
 # This is to make the verbatim font smaller;
 # Verbatim environment is not breaking long lines

docs/source/index.rst

@@ -12,7 +12,7 @@ Oriented Matroids
     :maxdepth: 1
 
     oriented_matroids/oriented_matroid
-    oriented_matroids/oriented_matroids_category
+    oriented_matroids/abstract_oriented_matroid
 
 Representations
 ---------------
@@ -22,7 +22,7 @@ Representations
 
     oriented_matroids/circuit_oriented_matroid
     oriented_matroids/covector_oriented_matroid
-    oriented_matroids/hyperplane_arrangement_oriented_matroid
+    oriented_matroids/real_hyperplane_arrangement_oriented_matroid
     oriented_matroids/vector_oriented_matroid
 
 Elements
@@ -32,7 +32,6 @@ Elements
     :maxdepth: 1
 
     oriented_matroids/signed_subset_element
-    oriented_matroids/signed_vector_element
 
 Indices and Tables
 ==================

docs/source/oriented_matroids/oriented_matroids_category.rst → docs/source/oriented_matroids/abstract_oriented_matroid.rst

@@ -1,9 +1,9 @@
 .. nodoctest
 
-Oriented Matroids Category
+Abstract Oriented Matroids
 ==========================
 
-.. automodule:: oriented_matroids.oriented_matroids_category
+.. automodule:: oriented_matroids.abstract_oriented_matroid
     :members:
     :undoc-members:
     :show-inheritance:

docs/source/oriented_matroids/real_hyperplane_arrangement_oriented_matroid.rst

@@ -0,0 +1,9 @@
+.. nodoctest
+
+Real Hyperplane Arrangement Oriented Matroids
+=============================================
+
+.. automodule:: oriented_matroids.real_hyperplane_arrangement_oriented_matroid
+    :members:
+    :undoc-members:
+    :show-inheritance:

makefile

@@ -4,12 +4,12 @@
 PACKAGE = oriented_matroids
 
 # change to your sage command if needed
-SAGE = /sage/sagedev/sage
+SAGE = /sage/sage/sage
 
 all: install test
 
 install:
-	$(SAGE) -pip install --upgrade --no-index -v .
+	$(SAGE) -pip install --upgrade --no-index --no-build-isolation -v .
 
 uninstall:
 	$(SAGE) -pip uninstall $(PACKAGE)

oriented_matroids/__init__.py

@@ -2,6 +2,6 @@
 from .oriented_matroid import OrientedMatroid
 from .abstract_oriented_matroid import AbstractOrientedMatroid
 
-from sage.misc.lazy_import import lazy_import
-#lazy_import('sage.matroids.oriented_matroids',
+# from sage.misc.lazy_import import lazy_import
+# lazy_import('sage.matroids.oriented_matroids',
 #            'oriented_matroids_catalog', 'oriented_matroids')