Skip to content

add summaries, add missing methods in the doc #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 15, 2019
Merged

add summaries, add missing methods in the doc #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion LICENSE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ License

The MIT License (MIT)

Copyright (c) 2017-2018 BladeX contributors
Copyright (c) 2017-2019 BladeX contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade._generate_lower_face
=======================================

.. currentmodule:: bladex.blade

.. automethod:: Blade._generate_lower_face
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade._generate_tip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade._generate_tip
================================

.. currentmodule:: bladex.blade

.. automethod:: Blade._generate_tip
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade._generate_upper_face
=======================================

.. currentmodule:: bladex.blade

.. automethod:: Blade._generate_upper_face
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade._import_occ_libs
===================================

.. currentmodule:: bladex.blade

.. automethod:: Blade._import_occ_libs
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade._write_blade_errors
======================================

.. currentmodule:: bladex.blade

.. automethod:: Blade._write_blade_errors
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade.generate_stl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade.generate_stl
===============================

.. currentmodule:: bladex.blade

.. automethod:: Blade.generate_stl
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.blade.Blade.rotate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.blade.Blade.rotate
=========================

.. currentmodule:: bladex.blade

.. automethod:: Blade.rotate
6 changes: 6 additions & 0 deletions docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bladex.ndinterpolator.scipy_bspline
===================================

.. currentmodule:: bladex.ndinterpolator

.. autofunction:: scipy_bspline
7 changes: 7 additions & 0 deletions docs/source/blade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,20 @@ Blade
Blade._check_params
Blade._check_string
Blade._compute_pitch_angle
Blade._generate_lower_face
Blade._generate_tip
Blade._generate_upper_face
Blade._import_occ_libs
Blade._induced_rake_from_skew
Blade._norm_to_abs
Blade._planar_to_cylindrical
Blade._write_blade_errors
Blade.apply_transformations
Blade.generate_iges
Blade.generate_stl
Blade.export_ppg
Blade.plot
Blade.rotate


.. autoclass:: Blade
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ BladeX is compatible with Python 2.7 and Python 3.6. Moreover, some of the modul
Python2.7 OCC installation:
::

conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=2.7
conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=2.7

Python3.6 OCC installation:
::

conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 python=3.6
conda install -c conda-forge -c dlr-sc -c pythonocc -c oce pythonocc-core==0.18.1 smesh=6.7.5 python=3.6


The `official distribution <https://github.com/mathLab/BladeX>`_ is on GitHub, and you can clone the repository using
Expand Down
1 change: 1 addition & 0 deletions docs/source/ndinterpolator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Ndinterpolator
RBF.thin_plate_spline
RBF.weights_matrix
reconstruct_f
scipy_bspline


.. automodule:: bladex.ndinterpolator
Expand Down