FY24 documentation improvements (part 1) #142

hugary1995 · 2024-05-02T22:22:09Z

Annual documentation season...

This is the first PR to document changes made in FY24

Added a syntax executable under the doc folder to help extract all the syntax
Change doxygen and doxygen-awesome-css from git submodules to cmake FetchContent
Update doxygen and doxygen-awesome-css to their latest versions
Reorganize documentation content to split user-facing and developer-facing content
Update the installation guide
Update the developer guide to reflect FY24 changes
Improve syntax documentation: extract class documentation, list objects by section, etc.

A follow on PR will add the user guide.

…odule

…nt release

github-actions · 2024-05-02T22:29:21Z

Python Binding Test Results (ubuntu-latest)

63 tests ±0 39 ✅ ±0 2s ⏱️ ±0s
1 suites ±0 24 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 63 and adds 63 tests. Note that renamed tests count towards both.

tests.python.base.test_HITParser ‑ test_parse
tests.python.models.test_Model ‑ test_get_model
tests.python.models.test_Model ‑ test_input_axis
tests.python.models.test_Model ‑ test_output_axis
tests.python.models.test_Model ‑ test_value
tests.python.models.test_Model ‑ test_value_and_dvalue
tests.python.models.test_ParameterStore ‑ test_named_parameters
tests.python.models.test_ParameterStore ‑ test_parameter_derivative
tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cpu-no grad]
tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
…

python.tests.base.test_HITParser ‑ test_parse
python.tests.models.test_Model ‑ test_get_model
python.tests.models.test_Model ‑ test_input_axis
python.tests.models.test_Model ‑ test_output_axis
python.tests.models.test_Model ‑ test_value
python.tests.models.test_Model ‑ test_value_and_dvalue
python.tests.models.test_ParameterStore ‑ test_named_parameters
python.tests.models.test_ParameterStore ‑ test_parameter_derivative
python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cpu-no grad]
python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
…

This pull request removes 24 skipped tests and adds 24 skipped tests. Note that renamed tests count towards both.

tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensor ‑ test_views[torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[B-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[C-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[B-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[C-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_batch_view[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_batch_view[B-torch.float64-cuda:0-no grad]
…

python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensor ‑ test_views[torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[B-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[C-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[B-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[C-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_batch_view[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_batch_view[B-torch.float64-cuda:0-no grad]
…

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:29:46Z

Test Results (macos-12-Debug-ON)

3 files ±0 3 suites ±0 1m 33s ⏱️ +5s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 051 runs - 3 3 051 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:30:50Z

Python Binding Test Results (macos-12)

63 tests ±0 39 ✅ ±0 2s ⏱️ -48s
1 suites ±0 24 💤 ±0
1 files ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 63 and adds 63 tests. Note that renamed tests count towards both.

tests.python.base.test_HITParser ‑ test_parse
tests.python.models.test_Model ‑ test_get_model
tests.python.models.test_Model ‑ test_input_axis
tests.python.models.test_Model ‑ test_output_axis
tests.python.models.test_Model ‑ test_value
tests.python.models.test_Model ‑ test_value_and_dvalue
tests.python.models.test_ParameterStore ‑ test_named_parameters
tests.python.models.test_ParameterStore ‑ test_parameter_derivative
tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cpu-no grad]
tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
…

python.tests.base.test_HITParser ‑ test_parse
python.tests.models.test_Model ‑ test_get_model
python.tests.models.test_Model ‑ test_input_axis
python.tests.models.test_Model ‑ test_output_axis
python.tests.models.test_Model ‑ test_value
python.tests.models.test_Model ‑ test_value_and_dvalue
python.tests.models.test_ParameterStore ‑ test_named_parameters
python.tests.models.test_ParameterStore ‑ test_parameter_derivative
python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cpu-no grad]
python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
…

This pull request removes 24 skipped tests and adds 24 skipped tests. Note that renamed tests count towards both.

tests.python.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensor ‑ test_views[torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[B-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_base_view[C-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[B-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_basic[C-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_batch_view[A-torch.float64-cuda:0-no grad]
tests.python.tensors.test_BatchTensorBase ‑ test_batch_view[B-torch.float64-cuda:0-no grad]
…

python.tests.tensors.test_BatchTensor ‑ test_named_ctors[torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensor ‑ test_views[torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[B-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_base_view[C-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[B-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_basic[C-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_batch_view[A-torch.float64-cuda:0-no grad]
python.tests.tensors.test_BatchTensorBase ‑ test_batch_view[B-torch.float64-cuda:0-no grad]
…

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:31:25Z

Test Results (ubuntu-latest-Debug-ON)

3 files ±0 3 suites ±0 1m 23s ⏱️ -13s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 051 runs - 3 3 051 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:32:56Z

Test Results (ubuntu-latest-Release-ON)

3 files ±0 3 suites ±0 34s ⏱️ -1s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 049 runs - 3 3 049 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:35:45Z

Test Results (macos-12-Release-ON)

3 files ±0 3 suites ±0 50s ⏱️ -37s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 049 runs - 3 3 049 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:44:18Z

Test Results (macos-12-Debug-OFF)

3 files ±0 3 suites ±0 1m 27s ⏱️ - 1m 4s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 051 runs - 3 3 051 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:53:43Z

Test Results (ubuntu-latest-Release-OFF)

3 files ±0 3 suites ±0 35s ⏱️ -1s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 049 runs - 3 3 049 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T22:56:54Z

Test Results (ubuntu-latest-Debug-OFF)

3 files ±0 3 suites ±0 1m 22s ⏱️ -14s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 051 runs - 3 3 051 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

github-actions · 2024-05-02T23:04:49Z

Test Results (macos-12-Release-OFF)

3 files ±0 3 suites ±0 49s ⏱️ +3s
474 tests - 1 474 ✅ - 1 0 💤 ±0 0 ❌ ±0
3 049 runs - 3 3 049 ✅ - 3 0 💤 ±0 0 ❌ ±0

Results for commit 27dd988. ± Comparison against base commit 2c12c8c.

This pull request removes 1 test.

unit_tests.global ‑ Fill3DVec

♻️ This comment has been updated with latest results.

…Catch2 v2 to v3

hugary1995 · 2024-05-03T16:08:17Z

Note that this PR gets rid of all submodules. Now this relies on CMake's FetchContent to pull dependencies on-demand. I am now a huge fan of CMake's FetchContent idea, and I think its development has become mature especially now that we require a recent CMake.

github-actions · 2024-05-07T19:42:12Z

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-06-14 01:15 UTC

… page

reverendbedford

For you

Add some additional documentation on the use of the python bindings.
Make some moderate effort to expand the object docstring and input documentation. Doesn't have to be fully comprehensive, but if we don't work on that now it's never going to happen.

For me

Crystal plasticity docs.

After this

Issue a new major release (b/c of python changes)
Update copyright year when we do that.

README.md

doc/content/install.md

doc/content/getting_started.md

doc/content/physics/solid_mechanics.md

…and solvers

reverendbedford · 2024-06-13T20:54:08Z

Missing syntax

Nothing, good job! 💜

hugary1995

LGTM. Unfortunately, docstring of individual options cannot render latex. I'll found two occurrences which I'll fix by either removing the formula or relocate them into the object summary doc.

src/neml2/models/crystallography/CubicCrystal.cxx

src/neml2/models/crystallography/user_tensors/FillMillerIndex.cxx

hugary1995 · 2024-06-14T00:08:12Z

The option docstring formula rendering issue is documented in issue #146. I'll merge when tests pass.

reverendbedford · 2024-06-14T01:04:14Z

Coverage after merging doc into main will be

88.00%

Coverage Report

File	Stmts	Branches	Funcs	Lines	Uncovered Lines
include/neml2/base
CrossRef.h	38.04%	100%	38.27%	36.36%	102, 104–105, 76, 94, 96–97
DependencyResolver.h	86.13%	100%	88.24%	85.83%	219, 221–222, 226, 229–231, 264, 291, 303, 313–314, 344, 346–347, 349–350
Factory.h	39%	100%	24.69%	100%
NEML2Object.h	50%	100%	22.22%	72.73%	50, 63, 66
OptionCollection.h	0%	100%	0%	0%	40, 49
OptionSet.h	39.28%	100%	35.85%	68.18%	128, 131, 134, 140, 146, 61, 66, 79, 81, 85, 89, 91, 93, 95
Registry.h	81.40%	100%	81.16%	100%
Storage.h	56.10%	100%	39.13%	77.78%	147–148, 150, 177
include/neml2/drivers
Driver.h	0%	100%	0%	0%	56
TransientDriver.h	85.71%	100%	100%	75%	149
include/neml2/misc
error.h	32.80%	100%	30.86%	63.64%	37–38, 40, 94, 96–99
math.h	100%	100%	100%	100%
parser_utils.h	56.07%	100%	46.34%	88%	37–38, 40
utils.h	56.40%	100%	47.30%	77.78%	173, 239, 241–246, 267, 302, 304–307
include/neml2/models
BufferStore.h	34.43%	100%	18.92%	58.33%	113, 115, 117–121, 133, 147, 151
ComposedModel.h	100%	100%	100%	100%
Data.h	100%	100%	100%	100%
Interpolation.h	69.81%	100%	55.56%	100%
LinearInterpolation.h	20%	100%	8.57%	100%
Model.h	85.19%	100%	75%	89.47%	116, 75
NonlinearParameter.h	10.53%	100%	5.56%	100%
ParameterStore.h	21.43%	100%	5.41%	52.63%	132, 134, 136–140, 148, 152
VariableStore.h	61.07%	100%	52.41%	89.47%	236, 238–239, 260, 91, 97
include/neml2/models/crystallography
CrystalGeometry.h	0%	100%	0%	0%	90, 92
MillerIndex.h	100%	100%	100%	100%
crystallography.h	100%	100%	100%	100%
include/neml2/solvers
Newton.h	100%	100%	100%	100%
NonlinearSystem.h	66.67%	100%	66.67%	66.67%	66
include/neml2/tensors
BatchTensorBase.h	58.59%	100%	43.88%	93.22%	212, 214, 256, 258
FixedDimTensor.h	26.44%	100%	19.32%	65.63%	152, 156, 168, 171, 176, 178, 183, 188, 66, 89, 91
LabeledAxis.h	0%	100%	0%	0%	142, 67, 72, 74–75, 77
LabeledAxisAccessor.h	72.97%	100%	65.22%	85.71%	46, 77
LabeledTensor.h	56.04%	100%	46.88%	77.78%	108, 112, 127, 176, 178–179
Scalar.h	44%	100%	34.55%	70%	82, 84–88
TensorValue.h	14%	100%	10.87%	50%	39, 63, 65, 75
Transformable.h	0%	100%	0%	0%	44
Variable.h	39.58%	100%	30.47%	82%	101, 107, 43–47, 49, 51
VecBase.h	80.95%	100%	50%	100%
src/neml2/base
CrossRef.cxx	83.87%	100%	75%	100%
Factory.cxx	100%	100%	100%	100%
HITParser.cxx	100%	100%	100%	100%
NEML2Object.cxx	91.67%	100%	100%	90%	35
OptionCollection.cxx	100%	100%	100%	100%
OptionSet.cxx	83.72%	100%	81.82%	84.38%	135, 137, 147, 149, 35
Parser.cxx	66.67%	100%	100%	64.29%	39–42, 54
Registry.cxx	75%	100%	66.67%	76.92%	38, 40–41, 56, 58–59
src/neml2/drivers
Driver.cxx	91.67%	100%	100%	90%	39
TransientDriver.cxx	86.60%	100%	100%	85.39%	142, 239–240, 245–247, 250–251, 255–259, 261–266, 269, 274–278, 99
src/neml2/drivers/solid_mechanics
LargeDeformationIncrementalSolidMechanicsDriver.cxx	32.39%	100%	25%	32.84%	100–102, 104–105, 109, 111, 113, 117, 119, 121, 125, 127–128, 130–131, 133–134, 137, 139–143, 63, 65–66, 68–74, 76, 78–79, 81, 83–84, 91–92, 94–95, 98
SolidMechanicsDriver.cxx	82.67%	100%	100%	81.69%	122, 124–125, 128, 130, 132, 135, 137, 151–153, 61, 91
src/neml2/misc
error.cxx	100%	100%	100%	100%
math.cxx	99.44%	100%	100%	99.33%	252
parser_utils.cxx	98.46%	100%	100%	98.18%	73
types.cxx	100%	100%	100%	100%
utils.cxx	89.47%	100%	100%	86.67%	44, 52
src/neml2/models
ArrheniusParameter.cxx	97.14%	100%	100%	96.88%	53
BackwardEulerTimeIntegration.cxx	94.12%	100%	77.78%	97.62%	56
BufferStore.cxx	33.33%	100%	33.33%	33.33%	36, 38, 40, 44, 46, 48–50
ComposedModel.cxx	94.87%	100%	100%	94.50%	117, 119, 163, 56, 69, 75
CopyVariable.cxx	35.62%	100%	33.33%	42.11%	46, 49, 51–52, 54, 58, 60–61, 63–64, 70
Data.cxx	90%	100%	100%	87.50%	35
ForceRate.cxx	98%	100%	100%	97.73%	49
ForwardEulerTimeIntegration.cxx	97.67%	100%	100%	97.30%	51
ImplicitUpdate.cxx	98.39%	100%	100%	98.28%	47
LinearInterpolation.cxx	61.18%	100%	40.74%	96.77%	42
Model.cxx	91.25%	100%	94.44%	90.80%	141–144, 177–179, 286, 288–291, 297, 422, 424–426, 428–429, 51, 79–80, 88, 96
NonlinearParameter.cxx	61.90%	100%	55.56%	100%
ParameterStore.cxx	48.08%	100%	22.73%	66.67%	101, 47, 49, 51–53, 66, 93, 95–96
RotationMatrix.cxx	95.83%	100%	100%	95.24%	45
SR2Invariant.cxx	96.49%	100%	100%	96.30%	112, 48
StateRate.cxx	94%	100%	66.67%	97.73%	49
SumModel.cxx	86.96%	100%	100%	85%	75–76, 79, 81–83
VariableStore.cxx	94.25%	100%	91.67%	94.67%	165–166, 63, 65
WR2ExplicitExponentialTimeIntegration.cxx	97.37%	100%	100%	97.14%	47
WR2ImplicitExponentialTimeIntegration.cxx	97.56%	100%	100%	97.37%	54
src/neml2/models/crystallography
CrystalGeometry.cxx	98.46%	100%	100%	98.25%	198, 61
CubicCrystal.cxx	93.75%	100%	100%	92.86%	51
MillerIndex.cxx	100%	100%	100%	100%
crystallography.cxx	98.28%	100%	100%	98.08%	142
src/neml2/models/crystallography/user_tensors
FillMillerIndex.cxx	94.44%	100%	100%	93.33%	44
SymmetryFromOrbifold.cxx	93.33%	100%	100%	92.31%	47
src/neml2/models/solid_mechanics
AssociativeIsotropicPlasticHardening.cxx	96.97%	100%	100%	96.67%	51
AssociativeKinematicPlasticHardening.cxx	97.06%	100%	100%	96.77%	53
AssociativePlasticFlow.cxx	96.67%	100%	100%	96.30%	50
ChabochePlasticHardening.cxx	97.83%	100%	100%	97.67%	65
Eigenstrain.cxx	90.91%	100%	100%	88.89%	38
ElasticStrain.cxx	97.14%	100%	100%	96.88%	53
Elasticity.cxx	96%	100%	100%	95.65%	52
FlowRule.cxx	92.31%	100%	100%	90.91%	40
GTNYieldFunction.cxx	57.14%	100%	100%	56.42%	113–114, 117, 120, 123, 168, 188–191, 194, 197–200, 217, 220, 223, 226, 253–257, 260, 263–266,

- Remove the page tag in README.md - Detect formula in option description ref #146

* Minor patch for #142 - Remove the page tag in README.md - Detect formula in option description - Use full syntax path in the syntax error message

hugary1995 added 4 commits May 2, 2024 09:20

Add a syntax executable

3629b54

Update doxygen and theme version; Remove the doxygen-awesome-css subm…

eb927aa

…odule

Reorganize doc content; Update developer guide according to the curre…

9b58d05

…nt release

Improve syntax documentation

73497e2

hugary1995 requested a review from reverendbedford May 2, 2024 22:27

hugary1995 added 8 commits May 2, 2024 22:36

Change Catch2 from git submodule to CMake FetchContent; Upgrade from …

8e97686

…Catch2 v2 to v3

Migrate benchmark tests from catch2 v2->v3

c641ce9

Change gpertools and hit from git submodule to cmake fetchcontent

ad779e2

Change pybind11 from a python package dependency to cmake fetchcontent

ecc83c0

requirements.txt no longer needed before python build

d0b2c48

minor installation guide tweak

d7da6a0

There is a gperftool bug after 2.13

cf31a1e

But does it even pull those unittests?

fc0af51

hugary1995 added 5 commits May 3, 2024 18:12

Add header permalink; Add physics documentation

dcbb660

split systems docs

2916100

Reorganization and more docs

fdc0248

Try previewing ghpages in PRs

64d2f51

No need to build unit tests anymore for the docs targets

c340733

hugary1995 added 6 commits June 5, 2024 17:01

Fix workflows

26488da

Fix pytest result publishing

d3f75c0

Fix c++ tests and coverage

04964a0

Fix testutils linking

5af2f5d

Adapt documentation

eb6245e

Add python installation instructions; Add more to the getting started…

6cc74c6

… page

reverendbedford requested changes Jun 12, 2024

View reviewed changes

reverendbedford and others added 9 commits June 12, 2024 10:19

Added crystal plasticity docs

a2fb1ec

Address individual comments

78a5677

some more cpp docstring (not syntax docstring)

8b350c4

Remove Fill3DVec; Document syntax for all tensors

c6148d2

Documented all models in the framework (excluding physics modules)

04aa2c9

Documented all solid mechanics models (excluding crystal plasticity) …

7b96df7

…and solvers

Document all drivers

ccbd15d

Log missing syntax doc

48345c2

Action to write missing syntax to github comments

bcc0fa3

reverendbedford added 3 commits June 13, 2024 16:04

Some docs, a test the comment updates

bda360d

Added all my missing docs, plus a few that Gary missed

4614d84

Hmm, learn to spell Gary

dac6b33

reverendbedford approved these changes Jun 13, 2024

View reviewed changes

hugary1995 commented Jun 14, 2024

View reviewed changes

src/neml2/models/crystallography/CubicCrystal.cxx Outdated Show resolved Hide resolved

src/neml2/models/crystallography/user_tensors/FillMillerIndex.cxx Outdated Show resolved Hide resolved

Relocate latex formulae in option docstring

27dd988

hugary1995 merged commit 1692e8b into main Jun 14, 2024
34 checks passed

hugary1995 deleted the doc branch June 14, 2024 01:07

hugary1995 added a commit that referenced this pull request Jun 14, 2024

Minor patch for #142

bb510c5

- Remove the page tag in README.md - Detect formula in option description ref #146

reverendbedford pushed a commit that referenced this pull request Jun 14, 2024

Minor patch for #142 (#147)

23a604c

* Minor patch for #142 - Remove the page tag in README.md - Detect formula in option description - Use full syntax path in the syntax error message

hugary1995 mentioned this pull request Jun 24, 2024

Make decorators to define the availability of model (second) derivatives #80

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FY24 documentation improvements (part 1) #142

FY24 documentation improvements (part 1) #142

hugary1995 commented May 2, 2024

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

hugary1995 commented May 3, 2024

github-actions bot commented May 7, 2024 •

edited

Loading

reverendbedford left a comment

reverendbedford commented Jun 13, 2024 •

edited

Loading

hugary1995 left a comment

hugary1995 commented Jun 14, 2024

reverendbedford commented Jun 14, 2024

FY24 documentation improvements (part 1) #142

FY24 documentation improvements (part 1) #142

Conversation

hugary1995 commented May 2, 2024

github-actions bot commented May 2, 2024 • edited Loading

Python Binding Test Results (ubuntu-latest)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (macos-12-Debug-ON)

github-actions bot commented May 2, 2024 • edited Loading

Python Binding Test Results (macos-12)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (ubuntu-latest-Debug-ON)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (ubuntu-latest-Release-ON)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (macos-12-Release-ON)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (macos-12-Debug-OFF)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (ubuntu-latest-Release-OFF)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (ubuntu-latest-Debug-OFF)

github-actions bot commented May 2, 2024 • edited Loading

Test Results (macos-12-Release-OFF)

hugary1995 commented May 3, 2024

github-actions bot commented May 7, 2024 • edited Loading

reverendbedford left a comment

Choose a reason for hiding this comment

For you

For me

After this

reverendbedford commented Jun 13, 2024 • edited Loading

Missing syntax

hugary1995 left a comment

Choose a reason for hiding this comment

hugary1995 commented Jun 14, 2024

reverendbedford commented Jun 14, 2024

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 2, 2024 •

edited

Loading

github-actions bot commented May 7, 2024 •

edited

Loading

reverendbedford commented Jun 13, 2024 •

edited

Loading