Refactoring #1497

Updated by pospelov almost 4 years ago

Within this item we have to agree on

* new Core directory structure (how to split, new directory names)
** Joachim's suggestion on new Core structure is a good starting point
* exact list of classes which should be renamed, and their new names
** also including form factors names

When we have a settled list, someone will create an issue and make the renaming in one go.

To my opinion it is important that

* this activity should not be smeared over time
** there should be well defined moment in time, when it begins, and when it ends
* this activity should not be mixed with another refactoring (like moving class methods around, method renaming here-and-there, change of parametrisation etc).
* it should be done in dedicated branch without mixing with unrelated commits
* we should plan it so well, to not to return to the subject month later.

Another suggestion is that the actual implementation should be done only after our continuous integration procedure is fully settled, i.e.

* we have nightly builds on Windows, MacOS and Linux
** including automatic generation of windows/macos installers
* we have automatic tests of user examples too
* our project should be already migrated to github/gitlab

|_. BornAgain |_. IsGISAXS |_. FitGISAXS |_. Rename |
| AnisoPyramid | AnisoPyramid | | |
| Box | Parallelepiped, Box | | |
| Cone | Cone | | |
| Cone6 | Cone6 | | |
| Cuboctahedron | Cuboctahedron | | |
| Cylinder | Cylinder | Cylinder | |
| | | Capsule | |
| EllipsoidalCylinder | EllipsoidalCylinder | | |
| FullSphere | FullSphere | | --> Sphere|
| FullSpheroid | FullSpheroid | Spheroid | --> Spheroid|
| HemiEllipsoid | HemiEllipsoid | | |
| | | Ellipsoid | |
| | | Hemispheroid | |
| Prism3 | Prims3 | Prism | |
| Prism6 | Prism6 | | |
| Pyramid | Pyramid | | |
| Ripple1 | | Ripple1 | --> CosineRipple|
| Ripple2 | | Ripple2 | --> TriangularRipple|
| Tetrahedron | Tetrahedron | TruncatedTethrahedron| --> TruncatedTethrahedron|
| TruncatedCube | | | --> FacettedCube|
| TruncatedSphere | Sphere | TruncatedSphere | |
| TruncatedSpheroid | Spheroid | | |
| | FacettedSphere (#1) | | |
| | | FacettedSphere (diff from #1) | |
| Icosahedron | | | |
| Dodecahedron | | | |

h3. Directory Structure

<pre>
./Sample
./FormFactors
./InterferenceFunctions
./Instrument
./InputOuput
./StandardSamples
./TestMachinery
./Basics
./Geometry
./Materials
</pre>

Back