Hidden vs public data files and naming convention

[yoelcortes]

About half of the data files are hidden with a leading underscore and the other half are public. And although there is a suggested convention for data within a module, there is no convention between the other modules. I propose the following convention:

• {property}_data_{method} for DataFrame with one set of property data:
  • critical_data_IUPAC
  • critical_data_Matthews
  • mu_data_VDI_PPDS_7
  • kappa_data_Perrys2_315
  • Hf_data_API_TDB
  • Cp_data_Poling
• {property}_values_{method} for arrays with one set of property data:
  • mu_values_VDI_PPDS_7
• {property}_dict_{method} for dictionary with one set of property data:
  • Cp_dict_Laliberte
  • rho_dict_Laliberte
• {method}_data for DataFrame with all sorts of property data:
  • VDI_tabular_data
  • CRC_inorganic_data
• {method}_values for arrays with all sorts of property data:
  • VDI_tabular_array
• {method}_dict for dictionary with all sorts of data:
  • VDI_saturation_dict
• {property}_sources for dictionary of data frames. Users could add their own data frame here too (I plan to in BioSTEAM).
  • Tc_sources
  • Tb_sources

I honestly don't mind whatever format we use (hidden or not). But as long as there is a convention we can follow, that would be dope.

[yoelcortes]

I also just noticed that some names have Dict, but are actually dataframes...

[CalebBell]

Hi Yoel, This seems like a great name convention. Good thinking! I think I went from the csv reader module, to a custom parser for everything based on to_num, played around with storing as numpy arrays, and then ended at pandas for most data reading things. I am not surprised the naming convention has been inconsistent!

[yoelcortes]

Thanks! Since part of this chemicals project is to expose the data, I'll keep these as public.

[yoelcortes]

I updated the convention so that its easier to autocomplete the names.