Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ The rules for this file:
use tabs but use spaces for formatting
* accompany each entry with github issue/PR number (Issue #xyz)

------------------------------------------------------------------------------
??/??/???? IAlibay, ollyfutur, conradolandia, orbeckst, PlethoraChutney, Pradyumn-cloud
-------------------------------------------------------------------------------
01/16/2026 IAlibay, ollyfutur, conradolandia, orbeckst, PlethoraChutney,
Pradyumn-cloud

* 1.1.0

Changes
Expand All @@ -30,7 +32,7 @@ The rules for this file:
(PR #142)
* `Grid` now allows forcing MRC/CCP4 maps to be read as volumes even when
the header indicates they are stacks of 2D images. (#150, PR #149)
* Added MRC file writing support (Issue #108)
* Added MRC file writing support (#108, PR #147)

Fixes

Expand Down
2 changes: 1 addition & 1 deletion doc/source/gridData/core.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.. automodule:: gridData.core
:members:

2 changes: 1 addition & 1 deletion doc/source/gridData/formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ small number of file formats is directly supported.
============================ ========== ========= ===== ===== =========================================
:mod:`~gridData.OpenDX` OpenDX_ dx x x subset of OpenDX implemented
:mod:`~gridData.gOpenMol` gOpenMol_ plt x
:mod:`~gridData.mrc` CCP4_ ccp4,mrc x subset implemented
:mod:`~gridData.mrc` CCP4_ ccp4,mrc x x subset implemented
:class:`~gridData.core.Grid` pickle pickle x x standard Python pickle of the Grid class
============================ ========== ========= ===== ===== =========================================

Expand Down
2 changes: 1 addition & 1 deletion doc/source/gridData/formats/OpenDX.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.. automodule:: gridData.OpenDX
:members:


2 changes: 1 addition & 1 deletion doc/source/gridData/formats/gOpenMol.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.. automodule:: gridData.gOpenMol
:members:

2 changes: 1 addition & 1 deletion doc/source/gridData/formats/mrc.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
.. automodule:: gridData.mrc
:members:

2 changes: 1 addition & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ GridDataFormats is open source and welcomes your contributions. Fork the `GridDa
.. Contents (sidebar)

.. toctree::
:maxdepth: 4
:maxdepth: 3
:hidden:

installation
Expand Down
42 changes: 40 additions & 2 deletions gridData/OpenDX.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,8 +160,46 @@
https://web.archive.org/web/20080808140524/http://opendx.sdsc.edu/docs/html/pages/usrgu068.htm
.. http://opendx.sdsc.edu/docs/html/pages/usrgu068.htm#HDREDF

Classes and functions
---------------------
Classes
-------

DX field class
~~~~~~~~~~~~~~

The primary class is :class:`field`, which is a container for the other classes.
It contains the following classes:

* :class:`gridpositions`
* :class:`gridconnections`
* :class:`array`

The :class:`gridpositions` class contains the position of the grid cells.
The :class:`gridconnections` class contains the connections between the grid cells.
The :class:`array` class contains the data on the grid.

.. autoclass:: field
:members:

DX components
~~~~~~~~~~~~~

The :class:`field` class contains the following components:

.. autoclass:: gridpositions
:members:

.. autoclass:: gridconnections
:members:

.. autoclass:: array
:members:

DX parser
~~~~~~~~~~
The :class:`DXParser` class is used to parse the DX file and construct the :class:`field` object.

.. autoclass:: DXParser
:members:

"""
import numpy
Expand Down
18 changes: 14 additions & 4 deletions gridData/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
# Copyright (c) 2009-2014 Oliver Beckstein <orbeckst@gmail.com>
# Released under the GNU Lesser General Public License, version 3 or later.
r"""
Core functionality for storing n-D grids --- :mod:`gridData.core`
=================================================================
Core functionality for storing n-D grids
========================================

The :mod:`core` module contains classes and functions that are
independent of the grid data format. In particular this module
Expand All @@ -19,10 +19,20 @@
g.load(filename) # populate with data from filename


Classes and functions
---------------------
Classes
-------

.. autoclass:: Grid
:members:
:undoc-members:
:show-inheritance:

Functions
---------

.. autofunction:: ndmeshgrid
"""

import os
import errno
import pickle
Expand Down
3 changes: 3 additions & 0 deletions gridData/gOpenMol.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,9 @@
Classes
-------

.. autoclass:: Plt
:members:

"""
import warnings
import struct
Expand Down
5 changes: 5 additions & 0 deletions gridData/mrc.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@
Classes
-------

.. autoclass:: MRC
:members:


"""
import numpy as np
import mrcfile
Expand Down Expand Up @@ -176,6 +180,7 @@ def write(self, filename):
header information (including mapc, mapr, maps ordering) is preserved.
Otherwise, standard ordering (mapc=1, mapr=2, maps=3) is used.


.. versionadded:: 1.1.0
"""
if filename is not None:
Expand Down