英国地质调查磁场计算器python api
magnetic-field-calculator的Python项目详细描述
磁场计算器
python api用于英国地质勘探磁场计算器。
说明
这个项目磁场计算器。它使用的是英国地质调查局(bgs)api的web服务进行计算。
web服务使世界磁模型(wmm)、国际地磁参考场(igrf)和bgs全球地磁模型(bggm)作为web服务可用。igrf和wmm对使用没有限制,bggm仅对订户可用。api提供了选择要使用的模型和版本的选项。世界上任何一点的磁场值都可以在给定的日期内得到。
项目不是BGS的一部分。它只是一个api客户端,由社区制作。有关bgs的任何信息,您应该使用the official website。
用法
首先,您需要导入计算器类:
frommagnetic_field_calculatorimportMagneticFieldCalculator
然后需要初始化计算器客户端,使用默认的wmm模型和最新的可用版本:
calculator=MagneticFieldCalculator()
型号、版本和自定义URS可通过参数进行更改:
calculator=MagneticFieldCalculator(model='wmm',revision='2015',sub_revision='2',custom_url='https://example.com')
然后可以得到给定位置的计算结果:
result=calculator.calculate(latitude=-80,longitude=140,altitude=200,date='2018-12-31')
唯一需要的参数是纬度和经度,但建议也设置其他参数以获得最佳结果。有些是独家的,你不应该同时使用它们。您还可以为受保护的模型设置http身份验证的用户名和密码。有关参数的详细信息,请参见the official documentation。
输出作为字典返回:
field_value=result['field-value']declination=field_value['declination']inclination=field_value['inclination']total_intensity=field_value['total-intensity']north_intensity=field_value['north-intensity']east_intensity=field_value['east-intensity']vertical_intensity=field_value['vertical-intensity']horizontal_intensity=field_value['horizontal-intensity']
某些输出属性将具有units
和value
子属性。输出格式将取决于使用的输入,特别是高度和日期。
您还可以查看example file以获取更多示例。
版本控制
此库使用SemVer进行版本控制。有关可用的版本,请参见此存储库上的the tags。
许可证
此库是根据GPLv3+许可证授权的。有关详细信息,请参见LICENSE文件。