From 9c67a5888be1beb86c9a45b0fb0c5c5880807104 Mon Sep 17 00:00:00 2001 From: Marco Tezzele Date: Tue, 15 Jan 2019 10:47:12 +0100 Subject: [PATCH] add summaries, add missing methods in the doc --- LICENSE.rst | 2 +- .../_summaries/bladex.blade.Blade._generate_lower_face.rst | 6 ++++++ .../source/_summaries/bladex.blade.Blade._generate_tip.rst | 6 ++++++ .../_summaries/bladex.blade.Blade._generate_upper_face.rst | 6 ++++++ .../_summaries/bladex.blade.Blade._import_occ_libs.rst | 6 ++++++ .../_summaries/bladex.blade.Blade._write_blade_errors.rst | 6 ++++++ docs/source/_summaries/bladex.blade.Blade.generate_stl.rst | 6 ++++++ docs/source/_summaries/bladex.blade.Blade.rotate.rst | 6 ++++++ .../_summaries/bladex.ndinterpolator.scipy_bspline.rst | 6 ++++++ docs/source/blade.rst | 7 +++++++ docs/source/index.rst | 4 ++-- docs/source/ndinterpolator.rst | 1 + 12 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade._generate_tip.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade.generate_stl.rst create mode 100644 docs/source/_summaries/bladex.blade.Blade.rotate.rst create mode 100644 docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst diff --git a/LICENSE.rst b/LICENSE.rst index 82639e9..2c4082e 100644 --- a/LICENSE.rst +++ b/LICENSE.rst @@ -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 diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst b/docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst new file mode 100644 index 0000000..50baffc --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade._generate_lower_face.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade._generate_lower_face +======================================= + +.. currentmodule:: bladex.blade + +.. automethod:: Blade._generate_lower_face \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_tip.rst b/docs/source/_summaries/bladex.blade.Blade._generate_tip.rst new file mode 100644 index 0000000..478b2a8 --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade._generate_tip.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade._generate_tip +================================ + +.. currentmodule:: bladex.blade + +.. automethod:: Blade._generate_tip \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst b/docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst new file mode 100644 index 0000000..2f0092e --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade._generate_upper_face.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade._generate_upper_face +======================================= + +.. currentmodule:: bladex.blade + +.. automethod:: Blade._generate_upper_face \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst b/docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst new file mode 100644 index 0000000..3238df9 --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade._import_occ_libs.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade._import_occ_libs +=================================== + +.. currentmodule:: bladex.blade + +.. automethod:: Blade._import_occ_libs \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst b/docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst new file mode 100644 index 0000000..74c180a --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade._write_blade_errors.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade._write_blade_errors +====================================== + +.. currentmodule:: bladex.blade + +.. automethod:: Blade._write_blade_errors \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade.generate_stl.rst b/docs/source/_summaries/bladex.blade.Blade.generate_stl.rst new file mode 100644 index 0000000..f6dd9f8 --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade.generate_stl.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade.generate_stl +=============================== + +.. currentmodule:: bladex.blade + +.. automethod:: Blade.generate_stl \ No newline at end of file diff --git a/docs/source/_summaries/bladex.blade.Blade.rotate.rst b/docs/source/_summaries/bladex.blade.Blade.rotate.rst new file mode 100644 index 0000000..5cc9c8d --- /dev/null +++ b/docs/source/_summaries/bladex.blade.Blade.rotate.rst @@ -0,0 +1,6 @@ +bladex.blade.Blade.rotate +========================= + +.. currentmodule:: bladex.blade + +.. automethod:: Blade.rotate \ No newline at end of file diff --git a/docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst b/docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst new file mode 100644 index 0000000..feca35a --- /dev/null +++ b/docs/source/_summaries/bladex.ndinterpolator.scipy_bspline.rst @@ -0,0 +1,6 @@ +bladex.ndinterpolator.scipy_bspline +=================================== + +.. currentmodule:: bladex.ndinterpolator + +.. autofunction:: scipy_bspline \ No newline at end of file diff --git a/docs/source/blade.rst b/docs/source/blade.rst index 09b7ef5..6635c52 100644 --- a/docs/source/blade.rst +++ b/docs/source/blade.rst @@ -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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 0e8a271..0e1051e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 `_ is on GitHub, and you can clone the repository using diff --git a/docs/source/ndinterpolator.rst b/docs/source/ndinterpolator.rst index 5e80328..d12bc57 100644 --- a/docs/source/ndinterpolator.rst +++ b/docs/source/ndinterpolator.rst @@ -16,6 +16,7 @@ Ndinterpolator RBF.thin_plate_spline RBF.weights_matrix reconstruct_f + scipy_bspline .. automodule:: bladex.ndinterpolator