gh-107: add all public functions/classes under glass namespace

[Saransh-cpp]

• All public or user-facing GLASS functionality now falls under the glass module name.
• Use absolute imports instead of relative imports within the package (PEP8)

Closes: #107
Changed: All the public functions and classes are now under the glass namespace

[coveralls]

Pull Request Test Coverage Report for Build 10903745730

Details

• 16 of 17 (94.12%) changed or added relevant lines in 6 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+1.8%) to 55.069%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
glass/lensing.py	0	1	0.0%

Totals
Change from base Build 10883249379:	1.8%
Covered Lines:	478
Relevant Lines:	868

---

💛 - Coveralls

[ntessore]

A quick grep -nRI 'glass.' glass shows the following additional locations:

glass/lensing.py:9:The :mod:`glass.lensing` module provides functionality for simulating
glass/lensing.py:43:    from glass.shells import RadialWindow
glass/lensing.py:386:    shells : list of :class:`~glass.shells.RadialWindow`
glass/user.py:9:The :mod:`glass.user` module contains convenience functions for users of the
glass/shapes.py:9:The :mod:`glass.shapes` module provides functionality for simulating the
glass/points.py:9:The :mod:`glass.points` module provides functionality for simulating point
glass/points.py:52:    w : :class:`~glass.shells.RadialWindow`
glass/points.py:126:        the :mod:`~glass.points` module, e.g. ``'linear'`` for
glass/fields.py:9:The :mod:`glass.fields` module provides functionality for simulating random
glass/observations.py:9:The :mod:`glass.observations` module provides functionality for simulating
glass/shells.py:9:The :mod:`glass.shells` module provides functions for the definition of
glass/shells.py:95:        >>> from glass.shells import RadialWindow
glass/galaxies.py:9:The :mod:`glass.galaxies` module provides functionality for simulating galaxies
glass/galaxies.py:46:    w : :class:`~glass.shells.RadialWindow`
glass/galaxies.py:212:    glass.observations.tomo_nz_gausserr :

[paddyroddy]

Isn't version one place where you don't do an absolute import? At least in my experience, but can't find a resource to back this up

[Saransh-cpp]

I use absolute for my projects and it works fine, but I can update this if relative is recommended for versions imports.

[paddyroddy]

Cool, I don't have a strong preference. Would be good if we can find a resource that does 😛

[Saransh-cpp]

Looked around a bit - setuptools_scm suggests using importlib.metadata to obtain version in __init__ file, but scientific-python/cookie suggests doing from ._version import version as __version__ (probably because this works with majority of the build-backends).

[paddyroddy]

I'd probably lean toward the scientific-python one, I must have found that convention somewhere!

[Saransh-cpp]

A quick grep -nRI 'glass.' glass shows the following additional locations:

Ah, I thought the modules should still import other modules explicitly so that developers know where the functions are coming from? They can look at the __init__ file too, but it should be fine to have long imports internally. I'll be happy to switch it to the new style tho.

[paddyroddy]

Ah, I thought the modules should still import other modules explicitly so that developers know where the functions are coming from? They can look at the __init__ file too, but it should be fine to have long imports internally. I'll be happy to switch it to the new style tho.

I would usually do this internally too, makes it easy to know where stuff comes from

[ntessore]

A quick grep -nRI 'glass.' glass shows the following additional locations:

Ah, I thought the modules should still import other modules explicitly so that developers know where the functions are coming from? They can look at the __init__ file too, but it should be fine to have long imports internally. I'll be happy to switch it to the new style tho.

Modules should import from the true location. Those examples are all user-facing text in the docs.

[Saransh-cpp]

Those examples are all user-facing text in the docs

Oh yes, I missed a few spots. Thank you!

[paddyroddy]

Much simpler, just change that version __init__.py thing and good to go I reckon

[paddyroddy]

I'd probably lean toward the scientific-python one, I must have found that convention somewhere!

[Saransh-cpp]

Thanks for the review! I'll also wait on @ntessore's approval on this.

[ntessore]

Great work, this had been stuck in the queue for ages!

[paddyroddy]

I've merged this as will need for #232