search

fnemina / pyOSOAA

pyOSOAA is a python interface for the Ocean Successive Orders with Atmosphere - Advanced (OSOAA) radiative transfer.
GNU General Public License v3.0
20 stars 6 forks source link

documentation and parameter setting #42

Open fserva opened 2 years ago

fserva commented 2 years ago

Hi @fnemina, I am a new user to pyOSOAA and I think it is a really useful software. Thanks for sharing it!

I'd like to ask if a list of the various possibilities to update parameters is documented somewhere. For example, I am not sure if the aerosol height scale ap.ha https://github.com/fnemina/pyOSOAA/blob/b3ad1a23eadd92ec1187fd6a850391fb8b1690ea/pyOSOAA/osoaa.py#L591 can be modified.

Thank you

fnemina commented 2 years ago

Hello @fserva , you can update all the possible variables in OSOAA from pyOSOAA except for a few that I have not implemented yet. However aerosol scale height should be implemented.

It is best to consult the OSOAA for better understanding of how all this variables can be adjusted. You can find it here in the doc section.

Please let me know if you need more information about this.

Best! Fran

fserva commented 2 years ago

Thanks @fnemina for the quick feedback! I guess in this case implementation should be not too difficult, thanks to the comprehensive documentation of OSOAA. I guess after SetMot in the AP class one could add something like: 

 def SetHa(self, ha=2.0):
        """ Define aerosol scale height
            ha          Aerosol scale height (km)
        """
        self.ha = ha

and maybe update test_osoaa.py and/or the notebook. Just let me know if you agree to have pull requests for these kind of changes, or prefer to take care of it directly.