Skip to content
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.

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

Update Documentation #165

Merged
merged 28 commits into from
Jul 2, 2021
Merged

Update Documentation #165

merged 28 commits into from
Jul 2, 2021

Conversation

lmh91
Copy link
Collaborator

@lmh91 lmh91 commented Jun 30, 2021

No description provided.

@lmh91 lmh91 mentioned this pull request Jun 30, 2021
@fhagemann
Copy link
Collaborator

fhagemann commented Jun 30, 2021

If we want to drop support for Julia 1.0, we couĺd also incorporate lines 29-33 back:
https://github.com/lmh91/SolidStateDetectors.jl/blob/docs/src/ConstructiveSolidGeometry/ConstructiveSolidGeometry.jl#L30

which will replace SolidStateDetectors.ConstructiveSolidGeometry.Cartesian with only Cartesian, whenever it is printed.
The same goes for Cylindrical. This resulted in errors in Julia 1.0

@fhagemann
Copy link
Collaborator

Also, is this PR mostly about the tutorial or also about docstrings?

@lmh91
Copy link
Collaborator Author

lmh91 commented Jun 30, 2021

It is only about the tutorial in the documentation.
Not it runs through again. Some changes were needed since SolidStateDetector is not mutable anymore.

But the plot recipes will need some further adjustments / improvements.
Docstrings can always be improved/added.

@lmh91
Copy link
Collaborator Author

lmh91 commented Jun 30, 2021

Regarding the Julia 1.0 comment:
I would do the drop of v1.0 in a dedicated PR.

r = r[2],
φ = φ,
θ = θ
) - Ellipsoid{T,ClosedPrimitive,T,typeof(φ),typeof(θ)}(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be an OpenPrimitive? Or do we want the inner radius excluded?
Also, treating a Sphere with an inner radius r1 != 0 results in failing tests.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah correct, that should be an OpenPrimitive.
Yes, the IO is not perfect yet. Also for other primitives.
That is something I want to talk about but not tackle in this PR.

csguniontype --> :difference
csg.a
label --> "CSG"
linestyle := isClosedPrimitive(ps[1]) ? :solid : :dot
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this means, that OpenPrimitives are always the negative geometry of a CSGDifference?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. Differences of Differences switches Open an Closed and so on...
There is no ideal solution for plotting this. This is just a simple way to have a look at the CSG.
But for sure nothing for a publication.

@lmh91 lmh91 merged commit 5007bcd into JuliaPhysics:v0.6 Jul 2, 2021
@lmh91 lmh91 deleted the docs branch July 14, 2021 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants