Merge pull request #51 from swagnercarena/read_the_docs

Read the docs fix

.readthedocs.yml

@@ -1,7 +1,14 @@
+version: 2
+
 build:
-  image: latest
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
 
 python:
-  version: 3.8
   install:
-    - requirements: requirements.txt
+    - requirements: requirements.txt
+    - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -12,7 +12,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import sys, os
-sys.path.append(os.path.abspath("."))
+sys.path.append(os.path.abspath("../"))
 import paltas
 
 

docs/paltas.generate.rst

@@ -0,0 +1,11 @@
+.. paltas:
+
+.. currentmodule:: paltas
+
+:mod:`generate` -- Dataset Generation Module
+============================================
+
+.. automodule:: paltas.generate
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx_rtd_theme

paltas/Configs/config_handler.py

@@ -71,7 +71,7 @@ def __init__(self,config_path,):
 		self.base_seed = getattr(
 			self.config_module,
 			'seed',
-			(np.random.randint(np.iinfo(np.uint32).max,)))
+			(np.random.randint(np.iinfo(np.uint32).max, dtype=np.int64)))
 		# Make sure base_seed is a sequence, not a number
 		if isinstance(self.base_seed, (int, float)):
 			self.base_seed = (self.base_seed,)
@@ -586,7 +586,7 @@ def _draw_image_drizzle(self):
 			self.kwargs_numerics = kwargs_numerics_copy
 			self.numpix = numpix_copy
 			raise
-					
+
 		self.sample['detector_parameters']['pixel_scale'] = detector_pixel_scale
 		self.numpix = numpix_copy
 

paltas/MainDeflector/simple_deflectors.py

@@ -146,6 +146,7 @@ def draw_main_deflector(self):
 class PEMDShearFourMultipole(PEMDShear):
 	"""Class for rendering a main deflector the includes a PEMD profile,
 	external shear, and order 2, 3, and 4 multipole.
+
 	Args:
 		main_deflector_parameters (dict): A dictionary containing the type of
 			main deflector and the value for each of its parameters.
@@ -156,7 +157,9 @@ class PEMDShearFourMultipole(PEMDShear):
 	Notes:
 		Uses the lenstronomy EPL class, which is equivalent to PEMD but is pure
 		python.
+
 	Required Parameters
+
 	- gamma - power law slope
 	- theta_E - Einstein radius of the profile in units of arcseconds
 	- e1 - x-direction ellipticity eccentricity
@@ -170,22 +173,16 @@ class PEMDShearFourMultipole(PEMDShear):
 	- z_lens - main deflector redshift
 	- mult2_a - multipole strength for order 2 multpole
 	- mult2_phi - multipole order 2 orientation in radians
-	- mult2_center_x - x-coordinate multipole order 2 center in units of
-	arcseconds
-	- mult2_center_y - y-coordinate multipole order 2 center in units of
-	arcseconds
+	- mult2_center_x - x-coordinate multipole order 2 center in units of arcseconds
+	- mult2_center_y - y-coordinate multipole order 2 center in units of arcseconds
 	- mult3_a - multipole strength for order 2 multpole
 	- mult3_phi - multipole order 2 orientation in radians
-	- mult3_center_x - x-coordinate multipole order 2 center in units of
-	arcseconds
-	- mult3_center_y - y-coordinate multipole order 2 center in units of
-	arcseconds
+	- mult3_center_x - x-coordinate multipole order 2 center in units of arcseconds
+	- mult3_center_y - y-coordinate multipole order 2 center in units of arcseconds
 	- mult4_a - multipole strength for order 2 multpole
 	- mult4_phi - multipole order 2 orientation in radians
-	- mult4_center_x - x-coordinate multipole order 2 center in units of
-	arcseconds
-	- mult4_center_y - y-coordinate multipole order 2 center in units of
-	arcseconds
+	- mult4_center_x - x-coordinate multipole order 2 center in units of arcseconds
+	- mult4_center_y - y-coordinate multipole order 2 center in units of arcseconds
 	"""
 	# Define the parameters we expect to find for the DG_19 model
 	required_parameters = PEMDShear.required_parameters + ('mult2_a',
@@ -201,6 +198,7 @@ def __init__(self,main_deflector_parameters,cosmology_parameters):
 	def draw_main_deflector(self):
 		"""Draws the lenstronomy profile names and kwargs for the components
 		of the main deflector.
+
 		Returns:
 			(tuple): A tuple of three lists: the first is the profile type for
 			each component of the main deflector, the second is the

paltas/__init__.py

@@ -1,6 +1,6 @@
 __author__ = 'Sebastian Wagner-Carena'
 __email__ = 'sebaswagner@outlook.com'
-__version__ = '0.1.1'
+__version__ = '0.2.0'
 
 # Analysis is not imported by default because it required tensorflow.
 try: