Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
Ann-Silje Kirkvik committed Nov 30, 2023
1 parent 51298e8 commit 45f8691
Show file tree
Hide file tree
Showing 10 changed files with 237 additions and 76 deletions.
124 changes: 62 additions & 62 deletions website_tools/docs/api/midgard-collections.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion website_tools/docs/api/midgard-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ individual entry, or for all entries in a configuration.

Full name: `midgard.config.config.CasedConfigParser`

Signature: `(defaults=None, dict_type=<class 'dict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object at 0x7f173bbcaea0>, converters=<object object at 0x7f173bbcaea0>)`
Signature: `(defaults=None, dict_type=<class 'dict'>, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section='DEFAULT', interpolation=<object object at 0x7f04eb3c6f20>, converters=<object object at 0x7f04eb3c6f20>)`

ConfigParser with case-sensitive keys

Expand Down
4 changes: 2 additions & 2 deletions website_tools/docs/api/midgard-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -1033,15 +1033,15 @@ logger is used to report the timing. See `Timer.__init__` for more details.

Full name: `midgard.dev.timer.AccumulatedTimer`

Signature: `(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(<function log at 0x7f174b56be20>, level='info')) -> None`
Signature: `(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(<function log at 0x7f04e3d4fe20>, level='info')) -> None`



### **Timer**

Full name: `midgard.dev.timer.Timer`

Signature: `(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(<function log at 0x7f174b56be20>, level='info')) -> None`
Signature: `(text: str = 'Elapsed time:', fmt: str = '.4f', logger: Optional[Callable[[str], NoneType]] = functools.partial(<function log at 0x7f04e3d4fe20>, level='info')) -> None`

Class for timing running time of functions and code blocks.

Expand Down
2 changes: 1 addition & 1 deletion website_tools/docs/api/midgard-gnss.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ use this model. The implementation is based on original paper of Klobuchar

Full name: `midgard.gnss.klobuchar.klobuchar`

Signature: `(time, ion_coeffs, rec_pos, az, el, freq_l1, freq=None, logger=functools.partial(<function log at 0x7f174b56be20>, level='debug'))`
Signature: `(time, ion_coeffs, rec_pos, az, el, freq_l1, freq=None, logger=functools.partial(<function log at 0x7f04e3d4fe20>, level='debug'))`

Compute the ionospheric time-delay correction for the single-frequency by broadcast model (klobuchar model)

Expand Down
2 changes: 1 addition & 1 deletion website_tools/docs/api/midgard-math.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Signature: `() -> None`


### constant (Constant)
`constant = Constant('/home/kirann/miniconda3/envs/where/lib/python3.10/site-packages/midgard/math/constant.txt')`
`constant = Constant('/opt/miniconda3/envs/where/lib/python3.11/site-packages/midgard/math/constant.txt')`


## midgard.math.ellipsoid
Expand Down
46 changes: 46 additions & 0 deletions website_tools/docs/api/midgard-parsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -795,6 +795,52 @@ and **meta**-data:
| \__parser_name__ | Parser name |


## midgard.parsers.bernese_slr_plt
A parser for reading Bernese SLR PLT file

**Example:**

from midgard import parsers
p = parsers.parse_file(parser_name='bernese_slr_plt', file_path='SLR_20232580.PLT')
data = p.as_dict()

**Description:**

Reads data from files in Bernese PLT format.



### **BerneseSlrPltParser**

Full name: `midgard.parsers.bernese_slr_plt.BerneseSlrPltParser`

Signature: `(file_path: Union[str, pathlib.Path], encoding: Optional[str] = None) -> None`

A parser for reading Bernese SLR PLT file

Following **data** are available after reading Bernese PLT file:

| Parameter | Description |
|--------------------|--------------------------------------------------------------------------------|
| station | 4-digit station identifier |
| domes | domes number, e.g. 50107M001 |
| sat_prn | satellite, e.g. E18
| epoch | mjd of observation |
| residual | observation residual (mm) |
| azi | azimuth (deg) |
| ele | elevation (deg)


and **meta**-data:

| Key | Description |
|----------------------|--------------------------------------------------------------------------------------|
| \__data_path__ | File path |
| \__params__ | np.genfromtxt parameters |
| \__parser_name__ | Parser name |



## midgard.parsers.bernese_sta
A parser for reading station information in Bernese STA format

Expand Down
116 changes: 116 additions & 0 deletions website_tools/docs/api/midgard-site_info.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
# midgard.site_info
Common function used by site_info classes



### **convert_to_utc**()

Full name: `midgard.site_info.convert_to_utc`

Signature: `(time: datetime.datetime) -> datetime.datetime`

Convert datetime object to UTC

**Args:**

- `time`: Time zone aware datetime object

**Returns:**

Time zone unaware datetime object related to UTC


## midgard.site_info._site_info
Expand Down Expand Up @@ -95,6 +114,23 @@ Signature: `()`

Main class for converting antenna information from various sources into unified classes

### **AntennaGnssEu**

Full name: `midgard.site_info.antenna.AntennaGnssEu`

Signature: `(station: str, site_info: Dict[str, Any]) -> None`

Antenna class handling GnssEu API antenna station information


### **AntennaHistoryGnssEu**

Full name: `midgard.site_info.antenna.AntennaHistoryGnssEu`

Signature: `(station: str, source_data: Any = None, source_path: str = None) -> None`



### **AntennaHistorySinex**

Full name: `midgard.site_info.antenna.AntennaHistorySinex`
Expand Down Expand Up @@ -167,6 +203,23 @@ Signature: `()`

Main class for converting eccentricity information from various sources into unified classes

### **EccentricityGnssEu**

Full name: `midgard.site_info.eccentricity.EccentricityGnssEu`

Signature: `(station: str, site_info: Dict[str, Any]) -> None`

Eccentricity class handling gnssEu API eccentricity station information


### **EccentricityHistoryGnssEu**

Full name: `midgard.site_info.eccentricity.EccentricityHistoryGnssEu`

Signature: `(station: str, source_data: Any = None, source_path: str = None) -> None`



### **EccentricityHistorySinex**

Full name: `midgard.site_info.eccentricity.EccentricityHistorySinex`
Expand All @@ -192,6 +245,35 @@ Signature: `(station: str, site_info: Dict[str, Any]) -> None`
Eccentricity class handling SINEX file eccentricity station information


## midgard.site_info.gnsseu


## midgard.site_info.gnsseu.api
Python wrapper around the gnss-metadata.eu API

**Description:**
###Creates functions automatically based on the services listed on the Swagger help page referred to by URL.

**Example:**
from åsgard import gnsseu

# Get instance of GnssEuApi class with API methods based on default URL
api = gnsseu.api.GnssEuApi()

# Get instance of GnssEuApi class with API methods based on defined URL
api = gnsseu.api.GnssEuApi(url=""https://gnss-metadata.eu/site/api-json")



### **GnssEuApi**

Full name: `midgard.site_info.gnsseu.api.GnssEuApi`

Signature: `(url: str = 'https://gnss-metadata.eu/site/api-json') -> None`

A wrapper around the gnss-metadata.eu API


## midgard.site_info.identifier
Identifier information classes

Expand Down Expand Up @@ -230,6 +312,15 @@ Signature: `()`

Main class for converting identifier information from various sources into unified classes

### **IdentifierGnssEu**

Full name: `midgard.site_info.identifier.IdentifierGnssEu`

Signature: `(station: str, source_data: Any = None, source_path: str = None) -> None`

Identifier class handling gnssEu API identifier station information


### **IdentifierSinex**

Full name: `midgard.site_info.identifier.IdentifierSinex`
Expand Down Expand Up @@ -295,6 +386,23 @@ Signature: `()`

Main class for converting receiver information from various sources into unified classes

### **ReceiverGnssEu**

Full name: `midgard.site_info.receiver.ReceiverGnssEu`

Signature: `(station: str, site_info: Dict[str, Any]) -> None`

Receiver class handling gnssEu API receiver station information


### **ReceiverHistoryGnssEu**

Full name: `midgard.site_info.receiver.ReceiverHistoryGnssEu`

Signature: `(station: str, source_data: Any = None, source_path: str = None) -> None`



### **ReceiverHistorySinex**

Full name: `midgard.site_info.receiver.ReceiverHistorySinex`
Expand Down Expand Up @@ -367,6 +475,14 @@ Signature: `()`

Main class for converting site coordinates from various sources into unified classes

### **SiteCoordHistoryGnssEu**

Full name: `midgard.site_info.site_coord.SiteCoordHistoryGnssEu`

Signature: `(station: str, source_data: Any = None, source_path: str = None) -> None`



### **SiteCoordHistorySinex**

Full name: `midgard.site_info.site_coord.SiteCoordHistorySinex`
Expand Down
13 changes: 6 additions & 7 deletions website_tools/docs/api/midgard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ Note: Midgard is still in pre-alpha status. Its functionality will change,

Midgard comes organized into different subpackages:

+ writers
+ dev
+ math
+ gnss
+ config
+ collections
+ plot
+ site_info
+ ionosphere
+ data
+ collections
+ writers
+ dev
+ parsers
+ plot
+ math
+ files
+ gnss

Look for help inside each subpackage:

Expand Down
2 changes: 1 addition & 1 deletion website_tools/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Midgard v1.2.2
site_name: Midgard v1.3.0
theme: flatly
site_dir: ../docs
nav:
Expand Down
2 changes: 1 addition & 1 deletion website_tools/mkdocs.yml_template
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Midgard v1.2.2
site_name: Midgard v1.3.0
theme: flatly
site_dir: ../docs
nav:
Expand Down

0 comments on commit 45f8691

Please sign in to comment.