diff --git a/docs/build/doctrees/Callinfo.doctree b/docs/build/doctrees/Callinfo.doctree index 43c0b7f..54392ec 100644 Binary files a/docs/build/doctrees/Callinfo.doctree and b/docs/build/doctrees/Callinfo.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index b00a0ae..885df92 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/help.doctree b/docs/build/doctrees/help.doctree index b3f6054..37f96be 100644 Binary files a/docs/build/doctrees/help.doctree and b/docs/build/doctrees/help.doctree differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 4232e6d..768832e 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/license.doctree b/docs/build/doctrees/license.doctree index 3047286..b8dfed6 100644 Binary files a/docs/build/doctrees/license.doctree and b/docs/build/doctrees/license.doctree differ diff --git a/docs/build/doctrees/lookuplib.doctree b/docs/build/doctrees/lookuplib.doctree index 8789c1b..a3b43dc 100644 Binary files a/docs/build/doctrees/lookuplib.doctree and b/docs/build/doctrees/lookuplib.doctree differ diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index da9eb90..8df1402 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 600f158a9e0f0243044c536b465c44c7 +config: 28550054b902e31426622d239c737bb6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/Callinfo.html b/docs/build/html/Callinfo.html index 71fc4fc..f99d373 100644 --- a/docs/build/html/Callinfo.html +++ b/docs/build/html/Callinfo.html @@ -6,7 +6,7 @@ - Callinfo — pyhamtools 0.4.0 documentation + Callinfo — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - - - +
@@ -37,13 +35,7 @@
  • modules |
    • -
  • - next |
    • -
  • - previous |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -79,7 +71,7 @@ An instance of L
    -get_adif_id(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_adif_id(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns ADIF id of a callsign’s country

    @@ -107,7 +99,7 @@ No Country found for callsign

    -get_all(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_all(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Lookup a callsign and return all data available from the underlying database

    @@ -160,7 +152,7 @@ would be missing with Clublog (API or XML)
    -get_continent(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_continent(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns the continent Identifier of a callsign

    @@ -201,7 +193,7 @@ No Continent found for callsign

    -get_country_name(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_country_name(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns the country name where the callsign is located

    @@ -239,7 +231,7 @@ for countries. Example:

    -get_cqz(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_cqz(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns CQ Zone of a callsign

    @@ -268,7 +260,7 @@ no CQ Zone found for callsign

    static get_homecall(callsign)
    -

    Strips off country prefixes (HC2/ DH1TW) and activity suffixes (DH1TW /P).

    +

    Strips off country prefixes (HC2/DH1TW) and activity suffixes (DH1TW/P).

    @@ -297,7 +289,7 @@ No callsign found in string
    -get_ituz(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_ituz(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns ITU Zone of a callsign

    @@ -329,7 +321,7 @@ No ITU Zone found for callsign

    -get_lat_long(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +get_lat_long(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Returns Latitude and Longitude for a callsign

    @@ -375,7 +367,7 @@ dedicated entry in the database exists.

    -is_valid_callsign(callsign, timestamp=datetime.datetime(2014, 9, 25, 21, 42, 32, 786909, tzinfo=<UTC>))
    +is_valid_callsign(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 995737, tzinfo=<UTC>))

    Checks if a callsign is valid

    @@ -416,15 +408,9 @@ dedicated entry in the database exists.

    -

    Previous topic

    -

    locator

    -

    Next topic

    -

    LookupLib

    This Page

    diff --git a/docs/build/html/_sources/index.txt b/docs/build/html/_sources/index.txt index af33f2e..748273b 100644 --- a/docs/build/html/_sources/index.txt +++ b/docs/build/html/_sources/index.txt @@ -12,34 +12,36 @@ :IRC: #hamtests on webirc.deltaxray.org PyHamTools is a Python library which helps you creating Amateur Radio applications faster. It comes -with some modules and classes which are frequently needed, like locator based calculations (distance, -heading, etc) or parsing of Amateur Radio callsigns. +with some modules and classes which are frequently needed: -Currently, PyHamtools contains the following modules and classes: + - Locator based calculations (distance, heading, sunrise/sunset, Locator to Lat/Long conversion) -Modules -^^^^^^^ -.. toctree:: - :maxdepth: 2 + - Checking frequencies against the IARU bandplan or - utils - locator + - Parsing Amateur Radio callsigns using Clublog.org_'s or AD1C's Country-Files.com_ database -Clases -^^^^^^ +PyHamTools is used in production at the DXHeat.com DXCluster_, performing several thousand lookups and calculations per day. + +.. _Clublog.org: https://secure.clublog.org/ +.. _Country-Files.com: http://www.country-files.com/ + +.. _DXCluster: https://dxheat.com + +PyHamTools Documentation +======================== + +Contents: .. toctree:: :maxdepth: 2 - Callinfo - LookupLib - - + reference + examples + changelog Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 9bcf2ba..4d6cfab 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -7,7 +7,7 @@ - Index — pyhamtools 0.4.0 documentation + Index — pyhamtools 0.4.1 documentation @@ -15,7 +15,7 @@ - +
    @@ -36,7 +36,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -61,33 +61,33 @@
    @@ -97,9 +97,15 @@
    -
    calculate_distance() (in module pyhamtools.locator) +
    calculate_distance() (in module pyhamtools.locator), [1]
    -
    calculate_distance_longpath() (in module pyhamtools.locator) +
    calculate_distance_longpath() (in module pyhamtools.locator), [1]
    -
    calculate_heading() (in module pyhamtools.locator) +
    calculate_heading() (in module pyhamtools.locator), [1]
    -
    calculate_heading_longpath() (in module pyhamtools.locator) +
    calculate_heading_longpath() (in module pyhamtools.locator), [1]
    -
    calculate_sunrise_sunset() (in module pyhamtools.locator) +
    calculate_sunrise_sunset() (in module pyhamtools.locator), [1]
    -
    Callinfo (class in pyhamtools.callinfo) +
    Callinfo (class in pyhamtools.callinfo), [1]
    -
    copy_data_in_redis() (pyhamtools.lookuplib.LookupLib method) +
    copy_data_in_redis() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    freq_to_band() (in module pyhamtools.utils) +
    freq_to_band() (in module pyhamtools.frequency)
    +
    + +
    (in module pyhamtools.utils), [1], [2] +
    + +
    @@ -107,37 +113,37 @@ @@ -147,13 +153,13 @@
    -
    get_adif_id() (pyhamtools.callinfo.Callinfo method) +
    get_adif_id() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_all() (pyhamtools.callinfo.Callinfo method) +
    get_all() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_continent() (pyhamtools.callinfo.Callinfo method) +
    get_continent() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_country_name() (pyhamtools.callinfo.Callinfo method) +
    get_country_name() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_cqz() (pyhamtools.callinfo.Callinfo method) +
    get_cqz() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_homecall() (pyhamtools.callinfo.Callinfo static method) +
    get_homecall() (pyhamtools.callinfo.Callinfo static method), [1]
    -
    get_ituz() (pyhamtools.callinfo.Callinfo method) +
    get_ituz() (pyhamtools.callinfo.Callinfo method), [1]
    -
    get_lat_long() (pyhamtools.callinfo.Callinfo method) +
    get_lat_long() (pyhamtools.callinfo.Callinfo method), [1]
    @@ -163,33 +169,33 @@
    -
    is_invalid_operation() (pyhamtools.lookuplib.LookupLib method) +
    is_invalid_operation() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    is_valid_callsign() (pyhamtools.callinfo.Callinfo method) +
    is_valid_callsign() (pyhamtools.callinfo.Callinfo method), [1]
    @@ -199,21 +205,25 @@
    -
    latlong_to_locator() (in module pyhamtools.locator) +
    latlong_to_locator() (in module pyhamtools.locator), [1]
    -
    locator_to_latlong() (in module pyhamtools.locator) +
    locator_to_latlong() (in module pyhamtools.locator), [1]
    -
    lookup_callsign() (pyhamtools.lookuplib.LookupLib method) +
    lookup_callsign() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    lookup_entity() (pyhamtools.lookuplib.LookupLib method) +
    lookup_entity() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    lookup_prefix() (pyhamtools.lookuplib.LookupLib method) +
    lookup_prefix() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    lookup_zone_exception() (pyhamtools.lookuplib.LookupLib method) +
    lookup_zone_exception() (pyhamtools.lookuplib.LookupLib method), [1]
    -
    LookupLib (class in pyhamtools.lookuplib) +
    LookupLib (class in pyhamtools.lookuplib), [1]
    @@ -255,7 +265,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • diff --git a/docs/build/html/help.html b/docs/build/html/help.html index b5e831f..fe21f36 100644 --- a/docs/build/html/help.html +++ b/docs/build/html/help.html @@ -6,7 +6,7 @@ - help — pyhamtools 0.4.0 documentation + help — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - +
    @@ -35,7 +35,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -86,7 +86,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • diff --git a/docs/build/html/index.html b/docs/build/html/index.html index 34ab7a1..f52653d 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -6,7 +6,7 @@ - PyHamTools — pyhamtools 0.4.0 documentation + PyHamTools — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - - + +
    @@ -37,9 +37,9 @@ modules |
  • - next |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -54,7 +54,7 @@
    - + @@ -69,43 +69,50 @@
    -
    pyhamtools.callinfo (module) +
    pyhamtools.callinfo (module), [1]
    -
    pyhamtools.locator (module) +
    pyhamtools.frequency (module) +
    + + +
    pyhamtools.locator (module), [1], [2]
    -
    pyhamtools.lookuplib (module) +
    pyhamtools.lookuplib (module), [1]
    -
    pyhamtools.utils (module) +
    pyhamtools.utils (module), [1], [2]
    Version:0.4.0
    Version:0.4.1
    Code:https://github.com/dh1tw/pyhamtools

    PyHamTools is a Python library which helps you creating Amateur Radio applications faster. It comes -with some modules and classes which are frequently needed, like locator based calculations (distance, -heading, etc) or parsing of Amateur Radio callsigns.

    -

    Currently, PyHamtools contains the following modules and classes:

    -
    -

    Modules

    +with some modules and classes which are frequently needed:

    +
    +
      +
    • Locator based calculations (distance, heading, sunrise/sunset, Locator to Lat/Long conversion)
      • +
    • Checking frequencies against the IARU bandplan or
      • +
    • Parsing Amateur Radio callsigns using Clublog.org‘s or AD1C’s Country-Files.com database
      • +
    +
    +

    PyHamTools is used in production at the DXHeat.com DXCluster, performing several thousand lookups and calculations per day.

    + -
    -

    Clases

    -
    - -
    -

    Indices and tables

    +

    Indices and tables

    -
    @@ -117,18 +124,15 @@ heading, etc) or parsing of Amateur Radio callsigns.

    Table Of Contents

    Next topic

    -

    utils

    +

    Reference

    This Page

    diff --git a/docs/build/html/license.html b/docs/build/html/license.html index 74fcf94..14a2fe1 100644 --- a/docs/build/html/license.html +++ b/docs/build/html/license.html @@ -6,7 +6,7 @@ - license — pyhamtools 0.4.0 documentation + license — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - +
    @@ -35,7 +35,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -112,7 +112,7 @@ SOFTWARE.

  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • diff --git a/docs/build/html/lookuplib.html b/docs/build/html/lookuplib.html index 0b730e7..41afb6a 100644 --- a/docs/build/html/lookuplib.html +++ b/docs/build/html/lookuplib.html @@ -6,7 +6,7 @@ - LookupLib — pyhamtools 0.4.0 documentation + LookupLib — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - - +
    @@ -36,10 +35,7 @@
  • modules |
    • -
  • - previous |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -72,7 +68,7 @@ The documentation of the various methods provide more detail.

    lookup against the Clublog API.

    The entire lookup data can also be copied into Redis, which an extremely fast in-memory Key/Value store. A LookupLib object can be instanciated to perform then all lookups in Redis, instead processing and loading -the data from Internet / File. This saves some time and allows several instances of LookupLib +the data from Internet / File. This saves some time and allows several instances of LookupLib to query the same data concurrently.

    @@ -152,7 +148,7 @@ instance of Redis, as well the python Redis connector (pip install redis-py).

    -is_invalid_operation(callsign, timestamp=datetime.datetime(2014, 9, 21, 18, 15, 2, 393560, tzinfo=<UTC>))
    +is_invalid_operation(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 994044, tzinfo=<UTC>))

    Returns True if an operations is known as invalid

    @@ -208,7 +204,7 @@ API Key for Clublog missing or incorrect
    -lookup_callsign(callsign=None, timestamp=datetime.datetime(2014, 9, 21, 18, 15, 2, 393534, tzinfo=<UTC>))
    +lookup_callsign(callsign=None, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 994018, tzinfo=<UTC>))

    Returns lookup data if an exception exists for a callsign

    @@ -314,7 +310,7 @@ the id 273.

    -lookup_prefix(prefix, timestamp=datetime.datetime(2014, 9, 21, 18, 15, 2, 393534, tzinfo=<UTC>))
    +lookup_prefix(prefix, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 994018, tzinfo=<UTC>))

    Returns lookup data of a Prefix

    @@ -372,7 +368,7 @@ database (default database).

    -lookup_zone_exception(callsign, timestamp=datetime.datetime(2014, 9, 21, 18, 15, 2, 393566, tzinfo=<UTC>))
    +lookup_zone_exception(callsign, timestamp=datetime.datetime(2014, 9, 26, 23, 10, 28, 994050, tzinfo=<UTC>))

    Returns a CQ Zone if an exception exists for the given callsign

    Args: callsign (string): Amateur radio callsign @@ -427,12 +423,9 @@ in CQ Zone 38

    -

    Previous topic

    -

    Callinfo

    This Page

    diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 44b3b46..289430d 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index b645e11..25995c7 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -6,7 +6,7 @@ - Python Module Index — pyhamtools 0.4.0 documentation + Python Module Index — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - + @@ -38,7 +38,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -67,17 +67,22 @@
    + + + @@ -118,7 +123,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • diff --git a/docs/build/html/search.html b/docs/build/html/search.html index ce9265e..4d8383f 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -6,7 +6,7 @@ - Search — pyhamtools 0.4.0 documentation + Search — pyhamtools 0.4.1 documentation @@ -14,7 +14,7 @@ - + @@ -43,7 +43,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • @@ -94,7 +94,7 @@
  • modules |
    • -
  • pyhamtools 0.4.0 documentation »
    • +
  • pyhamtools 0.4.1 documentation »
    • diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 0a1441c..2c00e05 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{all:[5,6,2],code:[0,5,6],illustr:[],queri:6,month:[4,6],prefix:[5,6],follow:[0,2,3,4,5,6],lookup:[5,6],typeerror:4,depend:[5,6],zone:[5,6],tobia:2,aris:2,merchant:2,digit:3,sourc:6,string:[4,5,6],fals:[5,6],shortpath:4,util:[],veri:5,"try":6,item:5,radio:[0,5,6],readthedoc:0,get_cqz:5,impli:2,consequ:5,second:4,download:6,even:6,index:0,lookup_prefix:6,neg:4,calcul:[0,4],asia:5,current:[0,5],delet:6,version:0,method:6,iaru:3,calculate_dist:4,let:6,path:4,modifi:2,valu:[4,6],search:0,cty:6,precis:5,datetim:[4,5,6],doctest:[],permit:2,action:2,extrem:6,typic:6,dh1tw:[0,5,1,2],freq_to_band:3,vp5:[],modul:[],africa:5,filenam:6,api:[5,6],instal:6,redi:6,callinfo:[],fed:[5,6],from:[4,3,5,6,2],usb:3,would:5,memori:6,two:[4,6],next:4,connector:6,qf67bf:4,call:[4,5],is_valid_callsign:5,type:[4,3,5,6],more:6,capit:5,notic:2,particular:2,known:6,herebi:2,none:[5,6],retriev:5,work:5,can:[5,6],purpos:[5,2],deg:4,claim:2,give:4,process:6,calc_dat:4,calculate_distance_longpath:4,onlin:6,plist:6,mylookuplib:6,get_country_nam:5,how:6,instead:6,updat:6,befor:6,wrong:[4,3],adif:[5,6],date:[4,6],"3d2ri":6,associ:2,github:0,author:2,correspond:4,gethomecal:[],issu:0,inform:[5,6],south:[4,5],allow:6,furnish:2,mydat:4,lsb:3,maidenhead:4,through:5,get_ituz:5,itu:5,paramet:[4,3,5,6],clublogxml:6,fit:2,tort:2,therefor:6,lookup_ent:6,"return":[4,3,5,6],python:[0,5,6],timestamp:[5,6],dai:[4,6],band:3,verifi:[],now:6,qrp:[],name:5,exampl:[4,3,5,6],mode:3,found:[5,6],attributeerror:4,replac:6,"static":5,connect:[6,2],year:[4,6],wgs84:4,event:2,out:[3,2],lookuptyp:[5,6],rep:[5,6],publish:2,content:[],internet:6,print:[4,3,6],bla:[],calculate_sunrise_sunset:4,differ:[5,6],free:2,base:0,dictionari:[3,5,6],org:[0,5,6],freq:3,lookup_callsign:6,hc2:5,frequenc:3,could:5,dp0gvn:6,assign:6,frequent:0,first:4,oper:6,softwar:2,suffix:5,directli:6,restrict:2,wrapper:6,noresult:[],miss:[5,6],utc:[4,5,6],given:6,"long":4,christma:6,data:[5,6],jn48qm:4,construct:5,station:6,store:6,option:[4,5,6],copi:[6,2],getter:[],pars:0,holder:2,kind:2,provid:[5,6,2],structur:[],charact:4,str:[3,5,6],posit:4,pre:5,"function":[],well:6,ani:[5,2],antarctica:[5,6],need:0,north:[4,5],seem:6,sell:2,hamtest:0,note:[],also:6,contact:[],redis_prefix:6,which:[0,6],get_adif_id:5,mit:[0,2],germani:[5,6],distribut:2,shall:2,object:[5,6],most:5,sublicens:2,bsd:[],america:5,"class":[0,5,6],charg:2,homogen:6,don:5,wellnitz:2,sunset:4,show:6,text:[],locator_to_latlong:4,myapikei:6,concurr:6,get_contin:5,permiss:2,xml:[5,6],access:[],onli:5,locat:6,copyright:2,explain:[],activ:5,should:[],jan:4,dict:[4,3,5,6],ituz:[5,6],tzinfo:[4,5,6],local:6,overwritten:6,variou:6,morning_dawn:4,express:2,liabl:2,geo:[],requir:6,"default":6,latlong_to_loc:4,stuff:[],contain:[0,3,5,6,4],where:5,set:6,copy_data_in_redi:6,see:0,arg:[4,6],subject:2,oceania:5,databas:[5,6],written:[],between:4,"import":[4,3,5,6],irc:0,accord:3,kei:6,calculate_head:4,entir:[5,6],distinguish:6,come:0,against:6,etc:[0,5],instanc:[5,6],countri:[5,6],com:[0,5,6],load:6,latitud:[4,5,6],damag:2,liabil:2,west:4,three:6,been:6,cqz:[5,6],is_invalid_oper:6,valueerror:[4,5],convert:[4,3],coordin:[4,5],pytz:[4,5,6],"case":5,east:4,aim:6,"while":5,apikei:6,abov:2,webirc:0,my_lookuplib:[5,6],non:4,contract:2,substanti:2,dedic:5,sever:[5,6],grant:2,perform:6,same:6,get_lat_long:5,lookuplib:[],complet:6,"5w1cfn":6,calculate_heading_longpath:4,http:[0,6],clublog:[5,6],rais:[4,3,5,6],noninfring:2,off:5,entri:5,clublogapi:6,vk9xo:6,person:2,without:[5,2],thi:[5,6,2],entiti:6,looktyp:6,identifi:[5,6],obtain:[6,2],europ:5,except:6,other:2,input:4,logger:[5,6],save:6,match:6,applic:0,format:[],distanc:[0,4],like:0,specif:[5,6],instanci:6,republ:5,necessari:[],either:4,page:0,underli:5,right:2,old:6,deal:2,some:[0,6],callsign:[0,5,6],home:5,successfulli:6,librari:[0,6],feder:5,lookup_zone_except:6,inject:[5,6],condit:2,complic:[],run:6,"__name__":[5,6],longpath:4,island:6,slightli:5,unfortun:5,locator2:4,locator1:4,apikeymissingerror:6,"float":[4,3],warranti:2,strip:5,ea1:[],evening_dawn:4,merg:2,get_al:5,log:[5,6],wai:[],whom:2,fast:6,avail:[5,6],start:4,reli:5,interfac:6,includ:2,bandplan:3,head:[0,4],amateur:[0,5,6],tupl:4,keyerror:[3,5,6],redis_inst:6,sunris:4,rotuma:6,"true":[5,6],cic:5,countryfil:[5,6],whether:2,record:6,contin:[5,6],limit:2,otherwis:2,khz:3,creat:[0,6],"int":[3,5,6],get_homecal:5,doesn:5,exist:[5,6],file:[0,5,6,2],pip:6,deltaxrai:0,check:[5,6],incorrect:6,when:[4,5,6],detail:6,invalid:[4,6],valid:[5,6],bool:[5,6],you:0,example_gener:[],longitud:[4,5,6],turkmenistan:6,infrequ:6,faster:0,descript:[],portion:2,getlogg:[5,6],time:[4,6],hello:[],daili:6},objtypes:{"0":"py:module","1":"py:function","2":"py:staticmethod","3":"py:method","4":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","staticmethod","Python static method"],"3":["py","method","Python method"],"4":["py","class","Python class"]},filenames:["index","help","license","utils","locator","Callinfo","LookupLib"],titles:["PyHamTools","help","license","utils","locator","Callinfo","LookupLib"],objects:{pyhamtools:{locator:[4,0,0,"-"],utils:[3,0,0,"-"],callinfo:[5,0,0,"-"],lookuplib:[6,0,0,"-"]},"pyhamtools.utils":{freq_to_band:[3,1,1,""]},"pyhamtools.lookuplib":{LookupLib:[6,4,1,""]},"pyhamtools.lookuplib.LookupLib":{lookup_entity:[6,3,1,""],lookup_zone_exception:[6,3,1,""],lookup_prefix:[6,3,1,""],copy_data_in_redis:[6,3,1,""],lookup_callsign:[6,3,1,""],is_invalid_operation:[6,3,1,""]},"pyhamtools.callinfo":{Callinfo:[5,4,1,""]},"pyhamtools.locator":{calculate_heading:[4,1,1,""],calculate_heading_longpath:[4,1,1,""],calculate_distance:[4,1,1,""],latlong_to_locator:[4,1,1,""],locator_to_latlong:[4,1,1,""],calculate_distance_longpath:[4,1,1,""],calculate_sunrise_sunset:[4,1,1,""]},"pyhamtools.callinfo.Callinfo":{get_cqz:[5,3,1,""],get_continent:[5,3,1,""],get_homecall:[5,2,1,""],get_country_name:[5,3,1,""],get_all:[5,3,1,""],get_lat_long:[5,3,1,""],is_valid_callsign:[5,3,1,""],get_adif_id:[5,3,1,""],get_ituz:[5,3,1,""]}},titleterms:{util:3,locat:4,help:1,anoth:[],licens:2,clase:0,simpl:[],indic:0,content:[],header:[],contact:2,tabl:0,pyhamtool:0,document:[],callinfo:5,modul:0,lookuplib:6,welcom:[]}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{all:[10,9,3,1],code:[0,9,10,3],illustr:[],queri:[10,8,3],"9h3a":4,month:[6,10,8,3],prefix:[9,10,3],follow:[6,10,9,3,1],lookup:[0,10,9,8,3],typeerror:[6,3],depend:[9,10,3],zone:9,tobia:1,aris:1,merchant:1,digit:3,sourc:[10,3],string:[6,9,10,3],fals:[9,10,3],shortpath:[],util:[],veri:[9,3],"try":[10,3],item:[9,3],quick:8,radio:[0,9,10,3],readthedoc:0,get_cqz:[9,3],impli:1,consequ:[9,3],second:[6,3],download:[10,8,3],even:[10,3],index:0,lookup_prefix:[10,3],neg:[6,3],section:8,calcul:4,asia:[9,3],current:[9,3],delet:[10,3],version:0,method:[10,3],iaru:[0,5,7,3],calculate_dist:[6,8,3],let:[10,3],path:[6,3],modifi:1,valu:[6,10,3],search:0,convers:0,anymor:[5,7,3],cty:[10,3],precis:[9,3],datetim:[6,10,9,8,3],doctest:[],permit:1,action:1,extrem:[10,3],typic:[10,3],dh1tw:[0,1,2,3,8,9],freq_to_band:[5,7,3,4],vp5:[],modul:[],africa:[9,3],filenam:[10,3],api:[9,10,3],instal:[10,3],redi:[10,3],callinfo:[],fed:[10,9,8,3],from:[1,3,6,8,9,10],usb:3,would:[9,3],memori:[10,3],sake:8,two:[],next:[6,8,3],connector:[10,3],qf67bf:[6,8,3],call:[6,9,3,4],is_valid_callsign:[9,3],dxcluster:0,type:[6,9,10,3],more:[10,3],capit:[9,3],notic:[5,7,3,1],files_:[],particular:1,known:[10,3],herebi:1,none:[9,10,3],retriev:[9,3],clublog_:[],work:[9,8,3],can:[10,9,8,3],purpos:[9,3,1],deg:[6,3],claim:1,give:[6,8,3],process:[10,3],calc_dat:[6,3],"14z":8,calculate_distance_longpath:[6,3],onlin:[10,3],plist:[10,3],mylookuplib:[10,3],secur:[],get_country_nam:[9,3],how:[10,8,3],instead:[10,3],updat:[10,3],product:0,ad1c:[0,8],befor:[10,3],wrong:[6,3],adif:[10,9,8,3],date:[6,10,3],"3d2ri":[10,3],associ:1,github:0,author:1,correspond:[6,3],gethomecal:[],issu:0,inform:[10,9,8,3],south:[6,9,3],allow:[10,3],furnish:1,mydat:[6,3],lsb:3,move:[5,7,3,4],maidenhead:[6,3],soon:[5,7,3],through:[9,8,3],get_ituz:[9,3],itu:9,paramet:[6,9,10,3],clublogxml:[10,3],fit:1,tort:1,therefor:[10,3],lookup_ent:[10,3],"return":[6,9,10,3],python:[0,9,10,3],timestamp:[9,10,3],dai:[0,10,8,3,6],band:[5,7,3],verifi:[],now:[10,8,3,4],qrp:[],name:[9,3],mode:[5,7,3],each:8,found:[9,10,3],c6a:4,attributeerror:[6,3],"short":4,replac:[10,3],"static":[9,3],connect:[10,3,1],year:[6,10,8,3],wgs84:[],event:1,out:[3,1],shown:8,lookuptyp:[10,9,8,3],rep:[10,9,8,3],publish:1,content:[],internet:[10,3],print:[6,10,8,3],bla:[],calculate_sunrise_sunset:[6,8,3],pleas:[5,7,3],given:[10,3],free:1,base:[0,4],dictionari:[9,10,3],org:[0,9,10,3],freq:[5,7,3],lookup_callsign:[10,3],hc2:[9,3],frequenc:4,could:[9,3],dp0gvn:[10,3],assign:[10,3],frequent:0,first:[6,8,3],oper:[10,3],softwar:1,suffix:[9,3],directli:[10,3],famou:[],restrict:1,lat:0,wrapper:[10,3],noresult:[],miss:[9,10,3],utc:[6,9,10,3],differ:[9,10,3,4],"long":[0,3,6],christma:[10,3],data:[10,9,8,3],jn48qm:[],my_dat:8,construct:[9,8,3],station:[10,3],conveni:8,store:[10,3],option:[6,9,10,3],copi:[10,3,1],getter:[],pars:0,holder:1,kind:1,provid:[10,9,3,1],remov:[5,7,3],structur:[],charact:[6,3],str:[9,10,3],posit:[6,3],pre:[9,3],"function":[5,7,8,3],well:[10,3],ani:[9,3,1],antarctica:[9,10,3],need:[0,8],north:[6,9,3],seem:[10,3],sell:1,hamtest:0,note:[],also:[10,3],exampl:9,redis_prefix:[10,3],which:[0,10,3],get_adif_id:[9,3],mit:[0,1],germani:[10,9,8,3],distribut:1,shall:1,object:[10,9,8,3],most:[9,3],sublicens:1,bsd:[],america:[9,3],"class":[0,10,9,8,3],charg:1,homogen:[10,3],don:[5,7,9,3],wellnitz:1,sunset:[],show:[10,3],text:[],locator_to_latlong:[6,3],myapikei:[10,3],concurr:[10,3],get_contin:[9,3],permiss:1,xml:[9,10,3],access:[],onli:[9,3],locat:[],copyright:1,explain:[],activ:[9,3],should:[],jan:[6,3],dict:[6,9,10,3],ituz:[10,9,8,3],tzinfo:[6,9,10,3],local:[10,3],overwritten:[10,3],variou:[10,3],morning_dawn:[6,3],express:1,liabl:1,geo:[],requir:[10,3],"default":[10,3],latlong_to_loc:[6,8,3],stuff:[],contain:[6,9,10,3],septemb:4,where:[9,3],set:[10,3],copy_data_in_redi:[10,3],see:0,arg:[6,10,3],subject:1,oceania:[9,3],correctli:4,databas:[0,10,9,8,3],written:[],between:[],"import":[6,10,9,8,3],irc:0,accord:[5,7,3],kei:[10,3],calculate_head:[6,8,3],entir:[9,10,3],distinguish:[10,3],come:0,against:[0,10,3],etc:[9,3],instanc:[9,10,3],countri:[9,4],com:[0,10,9,8,3],strftime:8,load:[10,3],latitud:9,damag:1,liabil:1,west:[6,3],three:[10,3],been:[5,7,10,3],cqz:[10,9,8,3],is_invalid_oper:[10,3],valueerror:[6,9,3],thousand:0,convert:[6,5,7,3],coordin:9,pytz:[6,9,10,3],understand:8,"case":[9,3],east:[6,3],aim:[10,3],"while":[9,3],apikei:[10,3],abov:1,webirc:0,almost:8,my_lookuplib:[10,9,8,3],non:[6,3],cluster:[],contract:1,substanti:1,dedic:[9,3],sever:[0,9,10,3],grant:1,perform:[0,10,8,3],same:[10,3],get_lat_long:[9,3],decod:4,lookuplib:[],complet:[10,3],"5w1cfn":[10,3],calculate_heading_longpath:[6,8,3],http:[0,10,3],clublog:[0,9,10,3],rais:[6,9,10,3],noninfring:1,off:[9,3],entri:[9,3],clublogapi:[10,3],without:[9,3,1],vk9xo:[10,3],person:1,contact:[],thi:[1,3,5,7,8,9,10],entiti:[10,3],latest:8,looktyp:[10,3],identifi:[9,10,3],obtain:[10,3,1],europ:[9,3],except:[10,3],other:1,input:[6,3],logger:[9,10,3],save:[10,3],match:[10,3],applic:0,format:[],distanc:[],like:[],specif:[9,10,3],deprec:[7,4],instanci:[10,8,3],republ:[9,3],necessari:[],either:[6,3],page:0,underli:[9,3],www:[],right:1,old:[10,3],deal:1,some:[0,10,8,3],callsign:9,home:[9,3],successfulli:[10,3],librari:[0,10,3],feder:[9,3],per:0,lookup_zone_except:[10,3],inject:[10,9,8,3],condit:1,complic:[],refer:8,"4km":8,run:[10,3],"__name__":[9,10,3],longpath:[],island:[10,3],slightli:[9,3],unfortun:[9,3],locator2:[6,8,3],locator1:[6,8,3],apikeymissingerror:[10,3],"float":[6,3],dxheat:0,automat:8,warranti:1,strip:[9,3],ea1:[],evening_dawn:[6,3],merg:1,get_al:[9,8,3],log:[9,10,3],wai:[],whom:1,fast:[10,3],avail:[9,10,3],start:[6,3],reli:[9,3],interfac:[10,3],includ:1,bandplan:[0,5,7,3],head:[],amateur:[0,9,10,3],tupl:[6,3],keyerror:[9,10,3],redis_inst:[10,3],sunris:[],my_loc:8,rotuma:[10,3],"true":[9,10,3],cic:[9,8,3],countryfil:[10,9,8,3],whether:1,record:[10,3],below:8,contin:[10,9,8,3],limit:1,"1fkm":8,otherwis:1,khz:[5,7,3],creat:[0,10,3],"int":[9,10,3],get_homecal:[9,3],doesn:[9,3],exist:[9,10,3],file:[0,1,3,8,9,10],our:8,pip:[10,3],deltaxrai:0,check:[0,9,10,3],incorrect:[10,3],when:[6,9,10,3],detail:[10,3],invalid:[6,10,3],valid:[9,10,3],bool:[9,10,3],you:[0,8],example_gener:[],"15z":8,longitud:9,turkmenistan:[10,3],infrequ:[10,3],faster:0,descript:[],portion:1,getlogg:[9,10,3],time:[6,10,3],hello:[],daili:[10,3]},objtypes:{"0":"py:module","1":"py:function","2":"py:staticmethod","3":"py:method","4":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","staticmethod","Python static method"],"3":["py","method","Python method"],"4":["py","class","Python class"]},filenames:["index","license","help","reference","changelog","utils","locator","frequency","examples","callinfo","lookupLib"],titles:["PyHamTools","license","help","Reference","Changelog","Utils","Locator calculations","Frequency","Examples","Callinfo","LookupLib"],objects:{pyhamtools:{locator:[3,0,0,"-"],utils:[5,0,0,"-"],frequency:[3,0,0,"-"],callinfo:[3,0,0,"-"],lookuplib:[3,0,0,"-"]},"pyhamtools.utils":{freq_to_band:[5,1,1,""]},"pyhamtools.lookuplib":{LookupLib:[3,4,1,""]},"pyhamtools.lookuplib.LookupLib":{lookup_entity:[3,3,1,""],lookup_zone_exception:[3,3,1,""],lookup_prefix:[3,3,1,""],copy_data_in_redis:[3,3,1,""],lookup_callsign:[3,3,1,""],is_invalid_operation:[3,3,1,""]},"pyhamtools.callinfo":{Callinfo:[3,4,1,""]},"pyhamtools.locator":{calculate_heading:[3,1,1,""],calculate_heading_longpath:[3,1,1,""],calculate_distance:[3,1,1,""],latlong_to_locator:[3,1,1,""],locator_to_latlong:[3,1,1,""],calculate_distance_longpath:[3,1,1,""],calculate_sunrise_sunset:[3,1,1,""]},"pyhamtools.callinfo.Callinfo":{get_cqz:[3,3,1,""],get_continent:[3,3,1,""],get_homecall:[3,2,1,""],get_country_name:[3,3,1,""],get_all:[3,3,1,""],get_lat_long:[3,3,1,""],is_valid_callsign:[3,3,1,""],get_adif_id:[3,3,1,""],get_ituz:[3,3,1,""]},"pyhamtools.frequency":{freq_to_band:[3,1,1,""]}},titleterms:{latitud:8,distanc:8,help:2,modul:[],indic:0,header:[],callsign:8,tabl:0,pyhamtool:[0,3,4],itu:8,callinfo:[9,3],locat:[6,8,3],welcom:[],zone:8,anoth:[],licens:1,jn48qm:8,two:8,content:[],contact:1,decod:8,between:8,document:0,simpl:[],lookuplib:[10,3],refer:3,head:8,wgs84:8,get:8,clase:[],util:[5,3],coordin:8,sunris:8,countri:8,longitud:8,longpath:8,shortpath:8,deprec:3,frequenc:[7,3],changelog:4,calcul:[6,8],exampl:8,sunset:8,januari:8}}) \ No newline at end of file diff --git a/docs/source/Callinfo.rst b/docs/source/Callinfo.rst deleted file mode 100644 index 68f7758..0000000 --- a/docs/source/Callinfo.rst +++ /dev/null @@ -1,10 +0,0 @@ -Callinfo -======== - -.. toctree:: - :maxdepth: 2 - -.. automodule:: pyhamtools.callinfo - -.. autoclass:: Callinfo - :members: \ No newline at end of file diff --git a/docs/source/LookupLib.rst b/docs/source/LookupLib.rst deleted file mode 100644 index 77cd8ef..0000000 --- a/docs/source/LookupLib.rst +++ /dev/null @@ -1,10 +0,0 @@ -LookupLib -========= - -.. toctree:: - :maxdepth: 2 - -.. automodule:: pyhamtools.lookuplib - -.. autoclass:: LookupLib - :members: \ No newline at end of file diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst new file mode 100644 index 0000000..601f495 --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1,22 @@ +Changelog +--------- + +PyHamTools 0.4.1 +================ + +27. September 2014 + + * short calls in different countries (e.g. 9H3A/C6A) are now decoded correctly + + * added pyhamtools.frequency + + * moved pyhamtools.utils.freq_to_band into pyhamtools.frequency + + * deprecated module pyhamtools.utils + +PyHamTools 0.4.0 +================ + +20. September 2014 + + * Added module for locator based calculations (pyhamtools.locators) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9efa5f8..ced893e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,7 +60,7 @@ copyright = u'2014, Tobias Wellnitz, DH1TW' # The short X.Y version. version = '0.4' # The full version, including alpha/beta/rc tags. -release = '0.4.0' +release = '0.4.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 0000000..0700c7e --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,80 @@ + +Examples +======== + +Almost each class / function in the reference section has an example. For the sake of convenience, some examples are shown below to give you a quick understanding how PyHamTools work. + +Calculate Shortpath and Longpath Heading between two locators +------------------------------------------------------------- + +.. code-block:: none + + >>> from pyhamtools.locator import calculate_heading, calculate_heading_longpath + >>> calculate_heading("JN48QM", "QF67bf") + 74.3136 + + >>> calculate_heading_longpath("JN48QM", "QF67bf") + 254.3136 + + +Calculate Distance between two WGS84 Coordinates +------------------------------------------------ + +.. code-block:: none + + >>> from pyhamtools.locator import calculate_distance, latlong_to_locator + >>> locator1 = latlong_to_locator(48.52, 9.375) + >>> locator2 = latlong_to_locator(-32.77, 152.125) + >>> distance = calculate_heading(locator1, locator2) + >>> print("%.1fkm" % distance) + 16466.4km + +Calculate Sunrise and Sunset for JN48QM on the 1. January 2015 +-------------------------------------------------------------- + + +.. code-block:: none + + >>> from pyhamtools.locator import calculate_sunrise_sunset + >>> from datetime import datetime + >>> my_locator = "JN48QM" + >>> my_date = datetime(year=2015, month=1, day=1) + >>> data = calculate_sunrise_sunset(my_locator, my_date) + >>> print "Sunrise: " + data['sunrise'].strftime("%H:%MZ") + ", Sunset: " + data['sunset'].strftime("%H:%MZ") + Sunrise: 07:14Z, Sunset: 16:15Z + + +Decode a Callsign and get Country name, ADIF ID, Latitude & Longitude +--------------------------------------------------------------------- + +In this example we will use AD1C's Country-files.com database to perform the lookup. + +First we need to instanciate a LookupLib object for Country-files.com database. The latest database will be downloaded automatically. + +.. code-block:: none + + >>> from pyhamtools import LookupLib, Callinfo + >>> my_lookuplib = LookupLib(lookuptype="countryfile") + + +Next, a Callinfo class needs to be instanciated. The lookuplib object will be injected on construction. + +.. code-block:: none + + >>> cic = Callinfo(my_lookuplib) + + +Now we can query the information conveniently through our Callinfo object: + +.. code-block:: none + + >>> cic.get_all("DH1TW") + { + 'country': 'Fed. Rep. of Germany', + 'adif': 230, + 'continent': 'EU', + 'latitude': 51.0, + 'longitude': -10.0, + 'cqz': 14, + 'ituz': 28 + } diff --git a/docs/source/index.rst b/docs/source/index.rst index af33f2e..748273b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,34 +12,36 @@ :IRC: #hamtests on webirc.deltaxray.org PyHamTools is a Python library which helps you creating Amateur Radio applications faster. It comes -with some modules and classes which are frequently needed, like locator based calculations (distance, -heading, etc) or parsing of Amateur Radio callsigns. +with some modules and classes which are frequently needed: -Currently, PyHamtools contains the following modules and classes: + - Locator based calculations (distance, heading, sunrise/sunset, Locator to Lat/Long conversion) -Modules -^^^^^^^ -.. toctree:: - :maxdepth: 2 + - Checking frequencies against the IARU bandplan or - utils - locator + - Parsing Amateur Radio callsigns using Clublog.org_'s or AD1C's Country-Files.com_ database -Clases -^^^^^^ +PyHamTools is used in production at the DXHeat.com DXCluster_, performing several thousand lookups and calculations per day. + +.. _Clublog.org: https://secure.clublog.org/ +.. _Country-Files.com: http://www.country-files.com/ + +.. _DXCluster: https://dxheat.com + +PyHamTools Documentation +======================== + +Contents: .. toctree:: :maxdepth: 2 - Callinfo - LookupLib - - + reference + examples + changelog Indices and tables ================== * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/docs/source/locator.rst b/docs/source/locator.rst deleted file mode 100644 index c8e2b84..0000000 --- a/docs/source/locator.rst +++ /dev/null @@ -1,8 +0,0 @@ -locator -======= - -.. toctree:: - :maxdepth: 2 - -.. automodule:: pyhamtools.locator - :members: \ No newline at end of file diff --git a/docs/source/reference.rst b/docs/source/reference.rst new file mode 100644 index 0000000..6ff5047 --- /dev/null +++ b/docs/source/reference.rst @@ -0,0 +1,39 @@ + +Reference +========= + +pyhamtools.locator +------------------ + +.. module:: pyhamtools.locator + +.. automodule:: pyhamtools.locator + :members: + +pyhamtools.frequency +-------------------- + +.. automodule:: pyhamtools.frequency + :members: + +pyhamtools.callinfo +------------------- + +.. automodule:: pyhamtools.callinfo + +.. autoclass:: Callinfo + :members: + +pyhamtools.lookuplib +-------------------- + +.. automodule:: pyhamtools.lookuplib + +.. autoclass:: LookupLib + :members: + +pyhamtools.utils (deprecated) +----------------------------- + +.. automodule:: pyhamtools.utils + :members: diff --git a/docs/source/utils.rst b/docs/source/utils.rst deleted file mode 100644 index 42a217b..0000000 --- a/docs/source/utils.rst +++ /dev/null @@ -1,8 +0,0 @@ -utils -===== - -.. toctree:: - :maxdepth: 2 - -.. automodule:: pyhamtools.utils - :members: \ No newline at end of file diff --git a/pyhamtools/callinfo.py b/pyhamtools/callinfo.py index 49c13ca..0d26700 100644 --- a/pyhamtools/callinfo.py +++ b/pyhamtools/callinfo.py @@ -135,7 +135,7 @@ class Callinfo(object): callsign = re.sub('/[A-Z0-9]{1,4}$', '', callsign) # cut off 2. appendix DH1TW/HC2/P -> DH1TW/HC2 # multiple character appendix (callsign/xxx) - if re.search('/[A-Z0-9]{2,4}$', callsign): # case call/xxx, but ignoring /p and /m or /5 + if re.search('[A-Z0-9]{4,10}/[A-Z0-9]{2,4}$', callsign): # case call/xxx, but ignoring /p and /m or /5 appendix = re.search('/[A-Z0-9]{2,4}$', callsign) appendix = re.sub('/', '', appendix.group(0)) self._logger.debug("appendix: " + appendix) diff --git a/pyhamtools/frequency.py b/pyhamtools/frequency.py new file mode 100644 index 0000000..f428708 --- /dev/null +++ b/pyhamtools/frequency.py @@ -0,0 +1,166 @@ +from pyhamtools.consts import LookupConventions as const + + +def freq_to_band(freq): + """converts a Frequency [kHz] into the band and mode according to the IARU bandplan + + Args: + frequency (float): Frequency in kHz + + Returns: + dict: Dictionary containing the band (int) and mode (str) + + Raises: + KeyError: Wrong frequency or out of band + + Example: + The following example converts the frequency *14005.3 kHz* into band and mode. + + >>> from pyhamtools.utils import freq_to_band + >>> print freq_to_band(14005.3) + { + 'band': 20, + 'mode': CW + } + + Note: + + Modes are: + + - CW + - USB + - LSB + - DIGITAL + + """ + + band = None + mode = None + if ((freq >= 135) and (freq <= 138)): + band = 2190 + mode = const.CW + elif ((freq >= 1800) and (freq <= 2000)): + band = 160 + if ((freq >= 1800) and (freq < 1838)): + mode = const.CW + elif ((freq >= 1838) and (freq < 1840)): + mode = const.DIGITAL + elif ((freq >= 1840) and (freq < 2000)): + mode = const.LSB + elif ((freq >= 3500) and (freq <= 4000)): + band = 80 + if ((freq >= 3500) and (freq < 3580)): + mode = const.CW + elif ((freq >= 3580) and (freq < 3600)): + mode = const.DIGITAL + elif ((freq >= 3600) and (freq < 4000)): + mode = const.LSB + elif ((freq >= 5000) and (freq <= 5500)): + band = 60 + elif ((freq >= 7000) and (freq <= 7300)): + band = 40 + if ((freq >= 7000) and (freq < 7040)): + mode = const.CW + elif ((freq >= 7040) and (freq < 7050)): + mode = const.DIGITAL + elif ((freq >= 7050) and (freq < 7300)): + mode = const.LSB + elif ((freq >= 10100) and (freq <= 10150)): + band = 30 + if ((freq >= 10100) and (freq < 10140)): + mode = const.CW + elif ((freq >= 10140) and (freq < 10150)): + mode = const.DIGITAL + elif ((freq >= 14000) and (freq <= 14350)): + band = 20 + if ((freq >= 14000) and (freq < 14070)): + mode = const.CW + elif ((freq >= 14070) and (freq < 14099)): + mode = const.DIGITAL + elif ((freq >= 14100) and (freq < 14350)): + mode = const.USB + elif ((freq >= 18068) and (freq <= 18268)): + band = 17 + if ((freq >= 18068) and (freq < 18095)): + mode = const.CW + elif ((freq >= 18095) and (freq < 18110)): + mode = const.DIGITAL + elif ((freq >= 18110) and (freq < 18268)): + mode = const.USB + elif ((freq >= 21000) and (freq <= 21450)): + band = 15 + if ((freq >= 21000) and (freq < 21070)): + mode = const.CW + elif ((freq >= 21070) and (freq < 21150)): + mode = const.DIGITAL + elif ((freq >= 21150) and (freq < 21450)): + mode = const.USB + elif ((freq >= 24890) and (freq <= 24990)): + band = 12 + if ((freq >= 24890) and (freq < 24915)): + mode = const.CW + elif ((freq >= 24915) and (freq < 24930)): + mode = const.DIGITAL + elif ((freq >= 24930) and (freq < 24990)): + mode = const.USB + elif ((freq >= 28000) and (freq <= 29700)): + band = 10 + if ((freq >= 28000) and (freq < 28070)): + mode = const.CW + elif ((freq >= 28070) and (freq < 28190)): + mode = const.DIGITAL + elif ((freq >= 28300) and (freq < 29700)): + mode = const.USB + elif ((freq >= 50000) and (freq <= 54000)): + band = 6 + if ((freq >= 50000) and (freq < 50100)): + mode = const.CW + elif ((freq >= 50100) and (freq < 50500)): + mode = const.USB + elif ((freq >= 50500) and (freq < 51000)): + mode = const.DIGITAL + elif ((freq >= 70000) and (freq <= 71000)): + band = 4 + mode = None + elif ((freq >= 144000) and (freq <= 148000)): + band = 2 + if ((freq >= 144000) and (freq < 144150)): + mode = const.CW + elif ((freq >= 144150) and (freq < 144400)): + mode = const.USB + elif ((freq >= 144400) and (freq < 148000)): + mode = None + elif ((freq >= 220000) and (freq <= 226000)): + band = 1.25 #1.25m + mode = None + elif ((freq >= 420000) and (freq <= 470000)): + band = 0.7 #70cm + mode = None + elif ((freq >= 902000) and (freq <= 928000)): + band = 0.33 #33cm US + mode = None + elif ((freq >= 1200000) and (freq <= 1300000)): + band = 0.23 #23cm + mode = None + elif ((freq >= 2390000) and (freq <= 2450000)): + band = 0.13 #13cm + mode = None + elif ((freq >= 3300000) and (freq <= 3500000)): + band = 0.09 #9cm + mode = None + elif ((freq >= 5650000) and (freq <= 5850000)): + band = 0.053 #5.3cm + mode = None + elif ((freq >= 10000000) and (freq <= 10500000)): + band = 0.03 #3cm + mode = None + elif ((freq >= 24000000) and (freq <= 24050000)): + band = 0.0125 #1,25cm + mode = None + elif ((freq >= 47000000) and (freq <= 47200000)): + band = 0.0063 #6,3mm + mode = None + else: + raise KeyError + + return {"band": band, "mode": mode} \ No newline at end of file diff --git a/pyhamtools/utils.py b/pyhamtools/utils.py index f428708..b86a867 100644 --- a/pyhamtools/utils.py +++ b/pyhamtools/utils.py @@ -4,33 +4,10 @@ from pyhamtools.consts import LookupConventions as const def freq_to_band(freq): """converts a Frequency [kHz] into the band and mode according to the IARU bandplan - Args: - frequency (float): Frequency in kHz - - Returns: - dict: Dictionary containing the band (int) and mode (str) - - Raises: - KeyError: Wrong frequency or out of band - - Example: - The following example converts the frequency *14005.3 kHz* into band and mode. - - >>> from pyhamtools.utils import freq_to_band - >>> print freq_to_band(14005.3) - { - 'band': 20, - 'mode': CW - } - Note: - - Modes are: - - - CW - - USB - - LSB - - DIGITAL + **DEPRECATION NOTICE** + This function has been moved to pyhamtools.frequency with PyHamTools 0.4.1 + Please don't use this module/function anymore. It will be removed soon. """ diff --git a/setup.py b/setup.py index aa79b09..82d1819 100755 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ if sys.version_info >= (3,): kw['use_2to3'] = True setup(name='pyhamtools', - version='0.4.0', + version='0.4.1', description='Collection of Tools for Amateur Radio developers', author='Tobias Wellnitz, DH1TW', author_email='Tobias@dh1tw.de', diff --git a/test/test_callinfo.py b/test/test_callinfo.py index f2aa25b..36d8621 100644 --- a/test/test_callinfo.py +++ b/test/test_callinfo.py @@ -138,7 +138,7 @@ class Test_callinfo_methods: assert fix_callinfo._dismantle_callsign("DH1TW") == response_prefix_DH_clublog assert fix_callinfo._dismantle_callsign("DL/HC2AO") == response_prefix_DH_clublog assert fix_callinfo._dismantle_callsign("9H5A/C6A") == response_prefix_C6A_clublog - # assert fix_callinfo._dismantle_callsign("C6A/9H5A") == response_Prefix_C6A + assert fix_callinfo._dismantle_callsign("C6A/9H5A") == response_prefix_C6A_clublog if fix_callinfo._lookuplib._lookuptype == "countryfile": assert fix_callinfo._dismantle_callsign("DH1TW/QRP") == response_prefix_DH_countryfile @@ -153,8 +153,7 @@ class Test_callinfo_methods: assert fix_callinfo._dismantle_callsign("DH1TW") == response_prefix_DH_countryfile assert fix_callinfo._dismantle_callsign("DL/HC2AO") == response_prefix_DH_countryfile assert fix_callinfo._dismantle_callsign("9H5A/C6A") == response_prefix_C6A_countryfile - # assert fix_callinfo._dismantle_callsign("C6A/9H5A") == response_Prefix_C6A - + assert fix_callinfo._dismantle_callsign("C6A/9H5A") == response_prefix_C6A_countryfile def test_lookup_callsign(selfself, fix_callinfo): diff --git a/test/test_utils_freq_to_band.py b/test/test_utils_freq_to_band.py index 39fc01c..b4065f9 100644 --- a/test/test_utils_freq_to_band.py +++ b/test/test_utils_freq_to_band.py @@ -1,5 +1,5 @@ import pytest -from pyhamtools.utils import freq_to_band +from pyhamtools.frequency import freq_to_band from pyhamtools.consts import LookupConventions as const class Test_utils_freq_to_band():
        - pyhamtools.callinfo + pyhamtools.callinfo
        - pyhamtools.locator + pyhamtools.frequency
        - pyhamtools.lookuplib + pyhamtools.locator +
        + pyhamtools.lookuplib