Skip to content

Commit

Permalink
Merge pull request #63 from WEgeophysics/develop
Browse files Browse the repository at this point in the history
 revised sphinx docs
  • Loading branch information
earthai-tech authored Sep 7, 2022
2 parents 2247042 + e1e482f commit 7e9014f
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 24 deletions.
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
contain the root `toctree` directive.
`pycsamt` documentation
======================
===========================

.. toctree::
:maxdepth: 2
Expand All @@ -22,7 +22,7 @@


Indices and tables
==================
====================

* :ref:`genindex`
* :ref:`modindex`
Expand Down
2 changes: 1 addition & 1 deletion docs/source/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Package Modeling


**Module Occam2D**
===================
=====================
.. automodule:: pycsamt.modeling.occam2d
:members:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Package Visualization
====================================


**Module PlotTemplates**
**Module Plot**
=========================
.. automodule:: pycsamt.view.plot
:members:
Expand Down
12 changes: 7 additions & 5 deletions pycsamt/geodrill/strata.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# -*- coding: utf-8 -*-
# Author: Kouadio K.Laurent<etanoyau@gmail.com>
# Licence: LGPL
# Licence: GPL
"""
.. _module-Strata::
:synopsis:Metaclasses of geostrata . Takes conventional strata geocodes
look in _geocodes folder . will be deprecated soon
Strata
==========
Metaclasses of geostrata .Takes conventional strata geocodes
look in _geocodes folder . will be deprecated soon
"""
from pycsamt.utils.geo_utils import mapping_stratum as setdico
try :
Expand Down
6 changes: 3 additions & 3 deletions pycsamt/modeling/occam2d.py
Original file line number Diff line number Diff line change
Expand Up @@ -2440,7 +2440,7 @@ def validate_iter2dat_file (iter2dat_fn) :

class occam2d_write(object):
"""
Special class to build occam2d imput files with :ref:`MTpy` module .
Special class to build occam2d imput files with `MTpy` module .
Arguments
--------
Expand Down Expand Up @@ -2529,8 +2529,8 @@ def buildingInputfiles(edi_fn, freq_num =None , savepath =None ,
interpolate_freq =False,
geoelectric_strike =None , **kwargs):
"""
Method to build Occam2D inputfiles. Deal with :ref:`MTpy` module.
Try to install :ref:`MTpy` is not installed yet.
Method to build Occam2D inputfiles. Deal with `MTpy`_ module.
Try to install `MTpy`_ is not installed yet.
:param edi_fn: full path to edifiles
:type edi_fn: str
Expand Down
13 changes: 3 additions & 10 deletions pycsamt/utils/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,6 @@

# from .func_utils import (
# scale_position,
# scale_values,
# reshape,
# make_ll_coordinates,
# fit_by_ll,
# get_interpolate_freqs,
# ismissing,
# fillNaN,
# load2array

# )
2


5 changes: 3 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#sphinx>=2.4.0
sphinx >=3.5
sphinx==5.0.2
matplotlib>=3.3.0
numpy
scipy
Expand All @@ -15,4 +15,5 @@ python-coveralls
tqdm
mtpy
geopandas

joblib
gdal

0 comments on commit 7e9014f

Please sign in to comment.