Doc review 2023 03 round 01 #869

gonuke · 2023-03-16T13:23:59Z

Description

First round of incremental documentation improvements in Spring 2023.

Motivation and Context

Documentation has become confusingly out of date and needs to be improved.

This round focuses on the home page and installation info.

pshriwise

Just a couple of small comments/questions from me. Thanks for kicking this effort off, @gonuke!

doc/install/dependencies.rst

pshriwise · 2023-03-16T16:13:33Z

doc/install/index.rst

+If you plan to use OpenMC_, you can follow their installation instructions with
+DAGMC built-in.


Might be good to link to the instructions here: https://docs.openmc.org/en/stable/quickinstall.html

pshriwise · 2023-03-16T16:18:28Z

doc/install/dependencies.rst

@@ -79,45 +79,33 @@ Redhat linux users can do likewise with:
 MOAB installation
 ~~~~~~~~~~~~~~~~~

-As of DAGMC version 3.1, MOAB version 5.1.0 or higher is required. The following
+As of DAGMC version 3.2, MOAB version 5.3.0 or higher is required. The following


Why is this again? My recollection is that we could still build the latest DAGMC with MOAB v5.1.0.

Good question... it may be <5.3.0 ? I'll check...

Just built DAGMC develop and v3.2 against MOAB v5.1.0 and didn't run into any issues. Maybe we can leave this for now.

pshriwise

Two small suggestions and I think that we're looking good here!

doc/install/dependencies.rst

doc/install/index.rst

doc/index.rst

gonuke · 2023-07-20T15:10:43Z

This is failing windows tests @pshriwise - but it's probably not because of this PR... I've addressed your questions, so let me know if you think it's ready to merge.

ahnaf-tahmid-chowdhury · 2023-07-20T15:26:02Z

This is failing windows tests @pshriwise - but it's probably not because of this PR... I've addressed your questions, so let me know if you think it's ready to merge.

Yes, I have also faced a similar problem in my PR #860. I am not sure, but I am assuming there is a bug in MOAB.

makeclean · 2023-07-20T15:31:48Z

Its a build failure due to Gtest bizzarely

D:\a\DAGMC\DAGMC\src\gtest\gtest-1.8.0\src/gtest-internal-inl.h(641,31): error C2039: 'SetUpTestCaseFunc': is not a member of 'testing::Test' [D:\a\DAGMC\build\src\gtest\gtest.vcxproj]

ahnaf-tahmid-chowdhury · 2023-07-20T18:13:38Z

Its a build failure due to Gtest bizzarely

D:\a\DAGMC\DAGMC\src\gtest\gtest-1.8.0\src/gtest-internal-inl.h(641,31): error C2039: 'SetUpTestCaseFunc': is not a member of 'testing::Test' [D:\a\DAGMC\build\src\gtest\gtest.vcxproj]

Dear @makeclean, I have updated gtest to v1.13.0 and found the same error. Here is the log.

doc/install/index.rst

ahnaf-tahmid-chowdhury · 2023-07-22T16:07:29Z

Dear @gonuke, I believe that some of the resolved changes might have been accidentally dropped in the latest force-push. Could you please check?

gonuke · 2023-07-22T16:09:29Z

Dear @gonuke, I believe that some of the resolved changes might have been accidentally dropped in the latest force-push. Could you please check?

Oh no! You may be right! Let me see if I can recover them manually

gonuke · 2023-08-13T20:17:05Z

Converted this to draft until #880 is merged

gonuke · 2023-08-16T01:37:21Z

This has been rebased & tested (over-tested for now since it's only a doc change) and ready to merge once @pshriwise approves changes.

Co-authored-by: Patrick Shriwise <[email protected]>

pshriwise

Thanks for diving into documentation updates, @gonuke!

What do you think about instructing users to rely on a package manager installation of HDF5 via apt or conda rather than recommending building from source?

pshriwise · 2023-08-18T17:20:01Z

tmp

Should this be here?

Nope - definitely not!!!

pshriwise

One small quibble...

pshriwise · 2023-08-19T05:44:15Z

doc/install/dependencies.rst

@@ -79,45 +79,32 @@ Redhat linux users can do likewise with:
 MOAB installation
 ~~~~~~~~~~~~~~~~~

-As of DAGMC version 3.1, MOAB version 5.1.0 or higher is required. The following
+As of DAGMC version 3.2, a MOAB version between 5.1.0 and 5.3.0 is required. The following


Why does this need to be between 5.10 and 5.3.0 again? I thought we could also support newer versions.

There are significant changes in v5.4.0 that are causing some build fail. We need to resolve this issue before proceeding to v5.4 MOAB.

Ah, I see. Perhaps we could clarify that the restriction to 5.4.0 is only for Windows if that is the case?

Our CI is stuck on 5.3.0 until we can figure out all the issues. It's a limitation for Ubuntu as well for 20.04 and older - seems to work on 22.04, though.

With all those caveats, it's seems best to stick with 5.3.0 for now

Fair enough! Strange though... hopefully we can figure it out someday.

pshriwise · 2023-08-19T17:46:14Z

@ahnaf-tahmid-chowdhury I'm happy with this if you are. If you don't have any further comments, feel free to merge!

... if you have permissions, that is. Otherwise I can take care of it.

ahnaf-tahmid-chowdhury · 2023-08-20T13:48:57Z

I'm also satisfied with it. After my most recent active PR gets merged, I'm considering creating a new PR to address the latest version of MOAB. It appears that I inadvertently created a forked repo from another fork last time.

pshriwise requested changes Mar 16, 2023

View reviewed changes

gonuke force-pushed the doc_review_2023_03 branch from caa1948 to 2cc4b7b Compare March 22, 2023 14:25

pshriwise requested changes Mar 22, 2023

View reviewed changes

doc/install/dependencies.rst Outdated Show resolved Hide resolved

doc/install/index.rst Outdated Show resolved Hide resolved

gonuke force-pushed the doc_review_2023_03 branch from 9a4aab9 to 9c5a15b Compare March 22, 2023 14:47

gonuke force-pushed the doc_review_2023_03 branch from 2204d39 to b652fe7 Compare April 30, 2023 15:06

gonuke requested review from pshriwise and shimwell May 1, 2023 12:27

ahnaf-tahmid-chowdhury requested changes Jul 20, 2023

View reviewed changes

doc/index.rst Outdated Show resolved Hide resolved

gonuke force-pushed the doc_review_2023_03 branch from 8606700 to da04814 Compare July 20, 2023 14:14

shimwell reviewed Jul 20, 2023

View reviewed changes

doc/install/index.rst Show resolved Hide resolved

ahnaf-tahmid-chowdhury mentioned this pull request Jul 21, 2023

Windows Build Failure with Gtest #885

Closed

gonuke force-pushed the doc_review_2023_03 branch from 9af046e to 3f459ce Compare July 25, 2023 22:45

gonuke force-pushed the doc_review_2023_03 branch from 3f459ce to 96e4aed Compare August 13, 2023 18:42

gonuke marked this pull request as draft August 13, 2023 20:16

gonuke force-pushed the doc_review_2023_03 branch 3 times, most recently from b53e1ad to ef287dd Compare August 16, 2023 01:02

gonuke marked this pull request as ready for review August 16, 2023 01:05

gonuke and others added 4 commits August 17, 2023 13:18

first tidy of main page and installation guidance

7f5ede1

change badges to Github

f2c2ae5

fix typos

d7ed5d1

Update doc/install/dependencies.rst

0033019

Co-authored-by: Patrick Shriwise <[email protected]>

gonuke added 7 commits August 17, 2023 13:18

A few updates

cb7ec57

resolve Changelog

cd3fbdf

sphinx formatting tweak

0e100bd

add openmc link

63b9a3c

restore some changes that were dropped in recent forced push

877450e

add constraint on moab version

00e8cde

no need to build/test on any pure doc changes

c3f4eb1

gonuke force-pushed the doc_review_2023_03 branch from 25c9df6 to c3f4eb1 Compare August 17, 2023 18:18

pshriwise requested changes Aug 18, 2023

View reviewed changes

get rid of extra file

ab2075b

pshriwise reviewed Aug 19, 2023

View reviewed changes

pshriwise approved these changes Aug 19, 2023

View reviewed changes

pshriwise merged commit b3e2b13 into svalinn:develop Aug 20, 2023
2 checks passed

gonuke deleted the doc_review_2023_03 branch August 21, 2023 00:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc review 2023 03 round 01 #869

Doc review 2023 03 round 01 #869

gonuke commented Mar 16, 2023

pshriwise left a comment

pshriwise Mar 16, 2023

pshriwise Mar 16, 2023

gonuke Mar 17, 2023

pshriwise Mar 21, 2023

pshriwise left a comment

gonuke commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 20, 2023

makeclean commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 22, 2023

gonuke commented Jul 22, 2023

gonuke commented Aug 13, 2023

gonuke commented Aug 16, 2023

pshriwise left a comment

pshriwise Aug 18, 2023

gonuke Aug 18, 2023

pshriwise left a comment

pshriwise Aug 19, 2023

ahnaf-tahmid-chowdhury Aug 19, 2023

pshriwise Aug 19, 2023

gonuke Aug 19, 2023

pshriwise Aug 19, 2023

pshriwise commented Aug 19, 2023 •

edited

Loading

ahnaf-tahmid-chowdhury commented Aug 20, 2023

		If you plan to use OpenMC_, you can follow their installation instructions with
		DAGMC built-in.

Doc review 2023 03 round 01 #869

Doc review 2023 03 round 01 #869

Conversation

gonuke commented Mar 16, 2023

Description

Motivation and Context

pshriwise left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pshriwise left a comment

Choose a reason for hiding this comment

gonuke commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 20, 2023

makeclean commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 20, 2023

ahnaf-tahmid-chowdhury commented Jul 22, 2023

gonuke commented Jul 22, 2023

gonuke commented Aug 13, 2023

gonuke commented Aug 16, 2023

pshriwise left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pshriwise left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pshriwise commented Aug 19, 2023 • edited Loading

ahnaf-tahmid-chowdhury commented Aug 20, 2023

pshriwise commented Aug 19, 2023 •

edited

Loading