MapLine 2.0.0__tar.gz → 2.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. mapline-2.0.1/MapLine.egg-info/PKG-INFO +558 -0
  2. {mapline-2.0.0 → mapline-2.0.1}/MapLine.egg-info/SOURCES.txt +1 -0
  3. {mapline-2.0.0 → mapline-2.0.1}/MapLine.egg-info/requires.txt +1 -0
  4. {mapline-2.0.0 → mapline-2.0.1}/MapLines/common/constants.py +1 -1
  5. mapline-2.0.1/MapLines/data/FeII.dat +1663 -0
  6. mapline-2.0.1/MapLines/tools/line_fit.py +889 -0
  7. mapline-2.0.1/MapLines/tools/mcmc.py +178 -0
  8. mapline-2.0.1/MapLines/tools/models.py +304 -0
  9. mapline-2.0.1/MapLines/tools/plot_tools.py +2349 -0
  10. mapline-2.0.1/MapLines/tools/priors.py +157 -0
  11. mapline-2.0.1/MapLines/tools/tools.py +2734 -0
  12. mapline-2.0.1/PKG-INFO +558 -0
  13. mapline-2.0.1/README.md +520 -0
  14. {mapline-2.0.0 → mapline-2.0.1}/bin/run_mapline +124 -5
  15. {mapline-2.0.0 → mapline-2.0.1}/setup.py +1 -0
  16. mapline-2.0.0/MapLine.egg-info/PKG-INFO +0 -215
  17. mapline-2.0.0/MapLines/tools/line_fit.py +0 -965
  18. mapline-2.0.0/MapLines/tools/mcmc.py +0 -60
  19. mapline-2.0.0/MapLines/tools/models.py +0 -147
  20. mapline-2.0.0/MapLines/tools/plot_tools.py +0 -291
  21. mapline-2.0.0/MapLines/tools/priors.py +0 -45
  22. mapline-2.0.0/MapLines/tools/tools.py +0 -693
  23. mapline-2.0.0/PKG-INFO +0 -215
  24. mapline-2.0.0/README.md +0 -178
  25. {mapline-2.0.0 → mapline-2.0.1}/MapLine.egg-info/dependency_links.txt +0 -0
  26. {mapline-2.0.0 → mapline-2.0.1}/MapLine.egg-info/not-zip-safe +0 -0
  27. {mapline-2.0.0 → mapline-2.0.1}/MapLine.egg-info/top_level.txt +0 -0
  28. {mapline-2.0.0 → mapline-2.0.1}/MapLines/__init__.py +0 -0
  29. {mapline-2.0.0 → mapline-2.0.1}/MapLines/common/__init__.py +0 -0
  30. {mapline-2.0.0 → mapline-2.0.1}/MapLines/tools/__init__.py +0 -0
  31. {mapline-2.0.0 → mapline-2.0.1}/pyproject.toml +0 -0
  32. {mapline-2.0.0 → mapline-2.0.1}/setup.cfg +0 -0
@@ -0,0 +1,558 @@
1
+ Metadata-Version: 2.4
2
+ Name: MapLine
3
+ Version: 2.0.1
4
+ Summary: A Python implementation of the 3D emission line fitting code
5
+ Home-page: https://github.com/hjibarram/Map_line
6
+ Download-URL: https://github.com/hjibarram/Map_line/archive/refs/tags/v2.0.1.tar.gz
7
+ Author: hjibarram
8
+ Author-email: hjibarram@gmail.com
9
+ License: MIT
10
+ Keywords: galaxies
11
+ Classifier: Development Status :: 5 - Production/Stable
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Classifier: Topic :: Scientific/Engineering :: Astronomy
15
+ Description-Content-Type: text/markdown
16
+ Requires-Dist: astropy
17
+ Requires-Dist: matplotlib
18
+ Requires-Dist: numpy
19
+ Requires-Dist: scipy
20
+ Requires-Dist: cloup
21
+ Requires-Dist: click
22
+ Requires-Dist: emcee
23
+ Requires-Dist: tqdm
24
+ Requires-Dist: corner
25
+ Requires-Dist: numpy-stl
26
+ Requires-Dist: cmasher
27
+ Dynamic: author
28
+ Dynamic: author-email
29
+ Dynamic: classifier
30
+ Dynamic: description
31
+ Dynamic: description-content-type
32
+ Dynamic: download-url
33
+ Dynamic: home-page
34
+ Dynamic: keywords
35
+ Dynamic: license
36
+ Dynamic: requires-dist
37
+ Dynamic: summary
38
+
39
+ # MapLine 2.0.1 🚀
40
+
41
+ ![Emission Line Fitting for IFU & AGN Spectra](https://github.com/hjibarram/Map_line/blob/dev/MapLine.png?raw=true)
42
+
43
+
44
+ ## 📖 Description
45
+
46
+ **MapLine** is an emission line fitting software optimized for active galactic nuclei (AGN) spectra, whether one-dimensional or obtained through integral field spectroscopy (IFS). Its main purpose is to characterize the broad and narrow components of various emission lines in the optical range. It allows modifying aspects such as the number of components to fit, the lines to consider, the flux profile (Gaussian, double Gaussian, Lorentzian, skew), the spectral fitting range, the input/output file type, continuum extraction, among others. The software is written in Python and has a modular structure, making it easy to customize and adapt to different analysis needs.
47
+
48
+ The package supports both:
49
+
50
+ - **single-spectrum fitting**
51
+ - **spatially resolved IFU cube fitting**
52
+
53
+ MapLines includes tools for spectral modeling, Bayesian parameter estimation
54
+ via MCMC, diagnostic plotting, and spatial analysis of emission-line
55
+ properties.
56
+
57
+ The full documentation can be looked at https://hjibarram.github.io/Map_line/index.html
58
+
59
+ ---
60
+
61
+ # Documentation
62
+
63
+ Complete documentation is available through the Sphinx documentation included
64
+ in the repository.
65
+
66
+ To build the documentation locally:
67
+
68
+ ```bash
69
+ cd docs
70
+ make html
71
+ ```
72
+
73
+ The generated documentation will appear in:
74
+
75
+ ```
76
+ docs/build/html/index.html
77
+ ```
78
+
79
+ The documentation includes:
80
+
81
+ - Installation guide
82
+ - Quickstart tutorial
83
+ - Configuration file documentation
84
+ - Methodology overview
85
+ - Example workflows
86
+ - CLI documentation
87
+ - Full API reference
88
+
89
+ ---
90
+
91
+ # Features
92
+
93
+ MapLines provides several features for emission-line analysis:
94
+
95
+ - Flexible emission-line modeling
96
+ - Gaussian, skewed Gaussian, Lorentzian, and Voigt profiles
97
+ - Outflow component modeling
98
+ - FeII template fitting
99
+ - Bayesian parameter estimation using **MCMC (emcee)**
100
+ - IFU cube fitting
101
+ - Diagnostic diagram generation (BPT, WHAN, WHAD)
102
+ - Spatial extraction tools
103
+ - Automated plotting utilities
104
+
105
+ ---
106
+
107
+ # 🛠 Installation
108
+
109
+ MapLines requires **Python ≥ 3.10** and the scientific Python ecosystem.
110
+
111
+ The recommended installation method is through a virtual environment.
112
+
113
+ ```bash
114
+ python -m venv .venv
115
+ source .venv/bin/activate
116
+ ```
117
+
118
+ Install the package from the repository:
119
+
120
+ ```bash
121
+ pip install -e .
122
+ ```
123
+
124
+ Typical dependencies include:
125
+
126
+ - numpy
127
+ - scipy
128
+ - matplotlib
129
+ - astropy
130
+ - emcee
131
+ - pyyaml
132
+ - corner
133
+
134
+ ---
135
+
136
+ # Command Line Interface
137
+
138
+ MapLines provides a command-line interface using **Click**.
139
+
140
+ The main command is:
141
+
142
+ ```bash
143
+ run_mapline
144
+ ```
145
+
146
+ Two main workflows are available.
147
+
148
+ ---
149
+
150
+ ## IFU cube fitting
151
+
152
+ ```bash
153
+ run_mapline run -g config.yml
154
+ ```
155
+
156
+ This command fits emission lines across an IFU data cube.
157
+
158
+ Outputs typically include:
159
+
160
+ - model FITS cubes
161
+ - parameter FITS cubes
162
+ - diagnostic plots
163
+
164
+ ---
165
+
166
+ ## Single-spectrum fitting
167
+
168
+ ```bash
169
+ run_mapline runoned -g config.yml
170
+ ```
171
+
172
+ This runs the fitting procedure on a single spectrum.
173
+
174
+ ---
175
+
176
+ # Configuration Files
177
+
178
+ MapLines uses YAML configuration files to define the spectral model and
179
+ fitting setup.
180
+
181
+ Typical configuration files include:
182
+
183
+ - `config.yml`
184
+ - `line_prop.yml`
185
+
186
+ These files define:
187
+
188
+ - emission lines to fit
189
+ - model components
190
+ - parameter priors
191
+ - fitting wavelength ranges
192
+
193
+ ---
194
+
195
+ # 📦 Project Structure
196
+
197
+ The core functionality is organized in the following modules:
198
+
199
+ ```
200
+ MapLines
201
+ │
202
+ ├── line_fit.py
203
+ │ Main spectral fitting routines
204
+ │
205
+ ├── models.py
206
+ │ Emission-line model definitions
207
+ │
208
+ ├── mcmc.py
209
+ │ Bayesian sampling utilities
210
+ │
211
+ ├── priors.py
212
+ │ Likelihood and prior functions
213
+ │
214
+ ├── tools.py
215
+ │ General utilities and data extraction tools
216
+ │
217
+ └── plot_tools.py
218
+ Visualization and diagnostic plotting
219
+ ```
220
+
221
+ ---
222
+
223
+ # Example Workflows
224
+
225
+ Example configurations and scripts are provided in:
226
+
227
+ ```
228
+ examples/
229
+ ├── single_spectra
230
+ ├── ifu_spectra
231
+ └── notebooks
232
+ ```
233
+
234
+ These demonstrate typical use cases such as:
235
+
236
+ - emission-line fitting
237
+ - IFU cube analysis
238
+ - diagnostic diagram generation
239
+ - spatial extraction of spectra
240
+
241
+ ---
242
+
243
+ # 📖 Documentation Structure
244
+
245
+ The Sphinx documentation is organized into two main sections.
246
+
247
+ ## User Guide
248
+
249
+ - Installation
250
+ - Quickstart
251
+ - Configuration
252
+ - Examples
253
+ - CLI usage
254
+ - Methodology
255
+
256
+ ## API Reference
257
+
258
+ - MapLines modules
259
+ - tools
260
+ - plot_tools
261
+ - mcmc
262
+ - priors
263
+
264
+ ---
265
+
266
+ # Contributing
267
+
268
+ Contributions are welcome.
269
+
270
+ You can contribute by:
271
+
272
+ - reporting bugs
273
+ - suggesting improvements
274
+ - adding features
275
+ - improving documentation
276
+
277
+ Please open an issue or pull request in the GitHub repository.
278
+
279
+ ---
280
+
281
+ # License
282
+
283
+ MapLines is distributed under the **MIT License**.
284
+
285
+ You are free to use, modify, and distribute it provided that proper
286
+ attribution is maintained.
287
+
288
+ ---
289
+
290
+
291
+
292
+
293
+ ## Contributions
294
+
295
+ Contributions to MapLine are welcome. You can submit your suggestions, bug reports, or improvements through the official GitHub repository.
296
+
297
+ ## License
298
+
299
+ MapLine is distributed under the MIT license. You are free to use, modify, and distribute it, as long as proper attribution is maintained.
300
+
301
+ # Acknowledgements
302
+
303
+ MapLines was developed for the analysis of emission-line spectra in
304
+ galaxies and AGN, with particular emphasis on applications to
305
+ integral-field spectroscopy surveys. HIM acknowledge the support from grants SECIHTI CBF2023-2024-1418 and CF-2023-G-543, PAPIIT UNAM IA104325, IN-106823, and IN-119123
306
+
307
+ ## Español
308
+ ## Descripción
309
+
310
+ **MapLine** es un software de ajuste de líneas de emisión optimizado para espectros de núcleos activos de galaxias (AGN), ya sean unidimensionales o obtenidos por espectroscopía de campo integral (IFS). Su principal propósito es caracterizar los componentes anchos y angostos de varias líneas de emisión en el rango óptico. Permite modificar aspectos como el número de componentes a ajustar, las líneas a considerar, el perfil de flujo (gaussiano, doble gaussiano, lorentziano, skew), el rango espectral de ajuste, el tipo de archivo de entrada/salida, la extracción del continuo, entre otros. El software está escrito en Python y tiene una estructura modular, lo cual facilita su personalización y adaptación a diferentes necesidades de análisis.
311
+
312
+ El paquete permite trabajar tanto con:
313
+
314
+ - **ajuste de espectros individuales**
315
+ - **ajuste de cubos IFU con resolución espacial**
316
+
317
+ MapLines incluye herramientas para el modelado espectral, estimación
318
+ bayesiana de parámetros mediante MCMC, generación de gráficos de diagnóstico
319
+ y análisis espacial de propiedades de líneas de emisión.
320
+
321
+ ---
322
+
323
+ # Documentación
324
+
325
+ La documentación completa está disponible a través de la documentación de
326
+ Sphinx incluida en el repositorio.
327
+
328
+ Para generar la documentación localmente:
329
+
330
+ ```bash
331
+ cd docs
332
+ make html
333
+ ```
334
+
335
+ La documentación generada aparecerá en:
336
+
337
+ ```
338
+ docs/build/html/index.html
339
+ ```
340
+
341
+ La documentación incluye:
342
+
343
+ - Guía de instalación
344
+ - Tutorial de inicio rápido
345
+ - Documentación de archivos de configuración
346
+ - Descripción de la metodología
347
+ - Flujos de trabajo de ejemplo
348
+ - Documentación de la interfaz de línea de comandos (CLI)
349
+ - Referencia completa de la API
350
+
351
+ ---
352
+
353
+ # Características
354
+
355
+ MapLines proporciona varias funcionalidades para el análisis de líneas de
356
+ emisión:
357
+
358
+ - Modelado flexible de líneas de emisión
359
+ - Perfiles Gaussianos, Gaussianos asimétricos (skewed), Lorentzianos y Voigt
360
+ - Modelado de componentes de outflow
361
+ - Ajuste de plantillas de FeII
362
+ - Estimación bayesiana de parámetros mediante **MCMC (emcee)**
363
+ - Ajuste de cubos IFU
364
+ - Generación de diagramas de diagnóstico (BPT, WHAN, WHAD)
365
+ - Herramientas de extracción espacial
366
+ - Utilidades automáticas de visualización
367
+
368
+ ---
369
+
370
+ # Instalación
371
+
372
+ MapLines requiere **Python ≥ 3.10** y el ecosistema científico de Python.
373
+
374
+ El método de instalación recomendado es mediante un entorno virtual.
375
+
376
+ ```bash
377
+ python -m venv .venv
378
+ source .venv/bin/activate
379
+ ```
380
+
381
+ Instalar el paquete desde el repositorio:
382
+
383
+ ```bash
384
+ pip install -e .
385
+ ```
386
+
387
+ Las dependencias típicas incluyen:
388
+
389
+ - numpy
390
+ - scipy
391
+ - matplotlib
392
+ - astropy
393
+ - emcee
394
+ - pyyaml
395
+ - corner
396
+
397
+ ---
398
+
399
+ # Interfaz de Línea de Comandos
400
+
401
+ MapLines proporciona una interfaz de línea de comandos utilizando **Click**.
402
+
403
+ El comando principal es:
404
+
405
+ ```bash
406
+ run_mapline
407
+ ```
408
+
409
+ Existen dos flujos de trabajo principales.
410
+
411
+ ---
412
+
413
+ ## Ajuste de cubos IFU
414
+
415
+ ```bash
416
+ run_mapline run -g config.yml
417
+ ```
418
+
419
+ Este comando ajusta líneas de emisión a lo largo de un cubo de datos IFU.
420
+
421
+ Las salidas típicamente incluyen:
422
+
423
+ - cubos FITS del modelo
424
+ - cubos FITS de parámetros
425
+ - gráficos de diagnóstico
426
+
427
+ ---
428
+
429
+ ## Ajuste de espectro individual
430
+
431
+ ```bash
432
+ run_mapline runoned -g config.yml
433
+ ```
434
+
435
+ Este comando ejecuta el procedimiento de ajuste sobre un espectro individual.
436
+
437
+ ---
438
+
439
+ # Archivos de Configuración
440
+
441
+ MapLines utiliza archivos de configuración en formato YAML para definir el
442
+ modelo espectral y la configuración del ajuste.
443
+
444
+ Los archivos típicos incluyen:
445
+
446
+ - `config.yml`
447
+ - `line_prop.yml`
448
+
449
+ Estos archivos definen:
450
+
451
+ - líneas de emisión a ajustar
452
+ - componentes del modelo
453
+ - priors de los parámetros
454
+ - rangos de longitud de onda para el ajuste
455
+
456
+ ---
457
+
458
+ # Estructura del Proyecto
459
+
460
+ La funcionalidad principal está organizada en los siguientes módulos:
461
+
462
+ ```
463
+ MapLines
464
+ │
465
+ ├── line_fit.py
466
+ │ Rutinas principales de ajuste espectral
467
+ │
468
+ ├── models.py
469
+ │ Definición de modelos de líneas de emisión
470
+ │
471
+ ├── mcmc.py
472
+ │ Utilidades para muestreo bayesiano
473
+ │
474
+ ├── priors.py
475
+ │ Funciones de verosimilitud y priors
476
+ │
477
+ ├── tools.py
478
+ │ Utilidades generales y herramientas de extracción de datos
479
+ │
480
+ └── plot_tools.py
481
+ Visualización y gráficos de diagnóstico
482
+ ```
483
+
484
+ ---
485
+
486
+ # Flujos de Trabajo de Ejemplo
487
+
488
+ Ejemplos de configuraciones y scripts se encuentran en:
489
+
490
+ ```
491
+ examples/
492
+ ├── single_spectra
493
+ ├── ifu_spectra
494
+ └── notebooks
495
+ ```
496
+
497
+ Estos demuestran casos de uso típicos como:
498
+
499
+ - ajuste de líneas de emisión
500
+ - análisis de cubos IFU
501
+ - generación de diagramas de diagnóstico
502
+ - extracción espacial de espectros
503
+
504
+ ---
505
+
506
+ # Estructura de la Documentación
507
+
508
+ La documentación generada con Sphinx está organizada en dos secciones
509
+ principales.
510
+
511
+ ## Guía de Usuario
512
+
513
+ - Instalación
514
+ - Inicio rápido
515
+ - Configuración
516
+ - Ejemplos
517
+ - Uso del CLI
518
+ - Metodología
519
+
520
+ ## Referencia de la API
521
+
522
+ - Módulos de MapLines
523
+ - tools
524
+ - plot_tools
525
+ - mcmc
526
+ - priors
527
+
528
+ ---
529
+
530
+ # Contribuciones
531
+
532
+ Las contribuciones son bienvenidas.
533
+
534
+ Puedes contribuir mediante:
535
+
536
+ - reporte de errores
537
+ - sugerencias de mejora
538
+ - desarrollo de nuevas funcionalidades
539
+ - mejora de la documentación
540
+
541
+ Por favor abre un issue o un pull request en el repositorio de GitHub.
542
+
543
+ ---
544
+
545
+ # Licencia
546
+
547
+ MapLines se distribuye bajo la **Licencia MIT**.
548
+
549
+ Eres libre de usar, modificar y distribuir el código siempre que se mantenga
550
+ la atribución correspondiente.
551
+
552
+ ---
553
+
554
+ # Agradecimientos
555
+
556
+ MapLines fue desarrollado para el análisis de espectros de líneas de emisión
557
+ en galaxias y AGN, con especial énfasis en aplicaciones a observaciones de
558
+ espectroscopía de campo integral. HIM agradece el apoyo de los proyectos SECIHTI CBF2023-2024-1418 y CF-2023-G-543, así como de los proyectos PAPIIT de la UNAM IA104325, IN-106823 e IN-119123.
@@ -10,6 +10,7 @@ MapLine.egg-info/top_level.txt
10
10
  MapLines/__init__.py
11
11
  MapLines/common/__init__.py
12
12
  MapLines/common/constants.py
13
+ MapLines/data/FeII.dat
13
14
  MapLines/tools/__init__.py
14
15
  MapLines/tools/line_fit.py
15
16
  MapLines/tools/mcmc.py
@@ -8,3 +8,4 @@ emcee
8
8
  tqdm
9
9
  corner
10
10
  numpy-stl
11
+ cmasher
@@ -3,5 +3,5 @@ import numpy as np
3
3
  globally across the MapLine modules
4
4
  """
5
5
 
6
- __version__ = 'MapLine v2.0.0'
6
+ __version__ = 'MapLine v2.0.1'
7
7