a documentation page as a script to run section by section, or the reference page of a function in the browser

Syntax

pages = openDoc()

The list of the documentation pages.

openDoc('EBSDAnalysis')

The pages of one chapter.

path = openDoc('EBSDTutorial')

The page as a script, opened in VS Code.

path = openDoc('EBSDTutorial', notebook=True)

The page as a Jupyter notebook.

url = openDoc('fibre.angle')

The reference page of a function by its name.

url = openDoc(calcGrains)

The reference page of a function itself.

url = openDoc(ori.mean)

The reference page of a method.

Description

A documentation page is written as .py, a "# %%" line before every section, into the current folder, and opened in VS Code, where every section runs on its own; with notebook=True it is written as the Jupyter notebook .ipynb. A file already there is kept unless overwrite=True. A function, class or method, by its name or itself, opens its page of the function reference on the MTEX website.

Input

name str, a documentation page, a chapter or the name of a function; or the function, class or method itself

Keywords

keyword default description
folder None the folder the script is written into, by default the current one
overwrite False write the page again over a file of its name
edit True open the script in VS Code, or the reference page in the browser; False only writes the file or returns the address
notebook False write a Jupyter notebook instead of a script

Output

out the list of pages for no name, the pages of a chapter, the path of the file written, or the address of the reference page

See also

mtexdata, Installation, MATLABtoPython

source

Citing this page. This page is part of the documentation of MTEX, a free and open source MATLAB toolbox for analyzing and modeling crystallographic textures. It was written by The MTEX Developers and is published at https://mtex-toolbox.github.io/openDoc_py.html. If you use MTEX, or reuse text or figures from this page, in your research, please cite

F. Bachmann, R. Hielscher, H. Schaeben: Texture Analysis with MTEX - Free and Open Source Software Toolbox, Solid State Phenomena 160 (2010), 63-68. 10.4028/www.scientific.net/SSP.160.63

BibTeX 
@article{bachmann2010mtex,
  author  = {F. Bachmann and R. Hielscher and H. Schaeben},
  title   = {Texture Analysis with MTEX - Free and Open Source Software Toolbox},
  journal = {Solid State Phenomena},
  volume  = {160},
  pages   = {63-68},
  year    = {2010},
  doi     = {10.4028/www.scientific.net/SSP.160.63},
  url     = {https://doi.org/10.4028/www.scientific.net/SSP.160.63}
}

Other papers describing specific MTEX methods are listed under Publications — please cite the one that best fits your application. The MTEX source code is licensed under the GNU General Public License v2.0; the text and figures of this documentation are licensed under CC BY 4.0, which permits reuse — including by automated systems — provided The MTEX Developers and this page are credited.